Skip to content

Commit 4d393d2

Browse files
committed
Standardize formatting and styles
Put installation options for each operating system into tabs
1 parent 2ceca22 commit 4d393d2

File tree

3 files changed

+26
-24
lines changed

3 files changed

+26
-24
lines changed

docs/classic-ui/whatsnew.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ myst:
1111

1212
# What's new in Plone 6 Classic UI
1313

14-
- HTML markup is now based on [Twitter Bootstrap 5](https://getbootstrap.com/).
15-
- Twitter Bootstrap 5 icons are now included.
16-
- Bootstrap JavaScript is available by default.
17-
- JavaScript has been modernized.
18-
- RequireJS has been removed.
19-
- Module Federation support for add-ons.
20-
- jQuery has been updated.
21-
- The TTW theming editor has been removed.
22-
Through-the-web theming is limited to downloading and uploading themes.
14+
- HTML markup is now based on [Twitter Bootstrap 5](https://getbootstrap.com/).
15+
- Twitter Bootstrap 5 icons are now included.
16+
- Bootstrap JavaScript is available by default.
17+
- JavaScript has been modernized.
18+
- RequireJS has been removed.
19+
- Module Federation support for add-ons.
20+
- jQuery has been updated.
21+
- The TTW theming editor has been removed.
22+
Through-the-web theming is limited to downloading and uploading themes.

docs/contributing/setup-build.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ myst:
99

1010
(setup-build-label)=
1111

12-
# Building and Checking the Quality of Documentation
12+
# Building and checking the quality of documentation
1313

1414
This document covers how to build the Plone Documentation and check it for quality.
1515

@@ -48,25 +48,25 @@ This is an easy way to become a contributor to Plone.
4848
```
4949

5050

51-
```{note}
52-
If you are using an M1 Mac to build the documentation, there is currently [an issue with pyenchant](https://github.com/pyenchant/pyenchant/issues/265) that throws an error that the enchant library can't be found.
53-
This happens for example if you install Python 3 with `pyenv` in the default M1 architecture (aarch64), so without following instructions to use Rosetta2 x86 emulation.
54-
A workaround until pyenchant is fixed is to run `export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib` in the terminal session before you execute `make html`.
55-
```
51+
(setup-build-installation-graphviz-label)=
5652

57-
Install [Graphviz](https://graphviz.org/download/) for graph visualization.
53+
### Graphviz
5854

59-
**macOS**
55+
Install [Graphviz](https://graphviz.org/download/) for graph visualization.
6056

57+
`````{tab-set}
58+
````{tab-item} macOS
6159
```shell
6260
brew install graphviz
6361
```
62+
````
6463
65-
**Ubuntu**
66-
64+
````{tab-item} Ubuntu
6765
```shell
6866
sudo apt-get install graphviz
6967
```
68+
````
69+
`````
7070

7171

7272
(setup-build-installation-clone-plone-documentation-label)=

docs/glossary.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -511,22 +511,24 @@ Zope Component Architecture
511511
The ZCA is not specific to the Zope web application server.
512512
It can be used for developing any Python application.
513513
Maybe it should be called Python Component Architecture.
514-
For more info read: https://muthukadan.net/docs/zca.html
514+
```{seealso}
515+
See also https://muthukadan.net/docs/zca.html.
516+
```
515517
516518
browser layer
517519
Layer
518-
A layer, or also called browser layer, is a marker interface and used in ZCML configurations.
520+
A layeralso called "browser layer"—is a marker interface and used in ZCML configurations.
519521
Layers allow you to enable and disable views and other site functionality based on installed add-ons and themes.
520522
521523
JSON
522-
JSON (JavaScript Object Notation, pronounced /ˈdʒeɪsən/; also /ˈdʒeɪˌsɒn/) is an open standard file format and data interchange format that uses human-readable text to store and transmit data objects consisting of attributevalue pairs and arrays (or other serializable values).
524+
JSON (JavaScript Object Notation, pronounced /ˈdʒeɪsən/; also /ˈdʒeɪˌsɒn/) is an open standard file format and data interchange format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays (or other serializable values).
523525
524526
```{seealso}
525527
See also https://en.wikipedia.org/wiki/JSON.
526528
```
527529
528-
HTTPRequest
529-
The HTTPRequest object contains information about the current request, which also includes browser layers.
530+
`HTTPRequest`
531+
The `HTTPRequest` object contains information about the current request, which also includes browser layers.
530532
531533
interface
532534
An interface is a mechanism for labeling objects as conforming to a given API or contract.

0 commit comments

Comments
 (0)