Skip to content

Commit 09220c3

Browse files
authored
Merge branch '6.0' into housecleaning-20260327
2 parents 4c00305 + 3799be8 commit 09220c3

15 files changed

Lines changed: 66 additions & 27 deletions

File tree

‎.github/workflows/test.yml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,15 @@ jobs:
1919
pip install -q -r requirements.txt
2020
sudo snap install --edge vale
2121
22-
- name: Run tests with make test
23-
run: make test
22+
- name: Build HTML
23+
run: make html
2424

2525
- name: Run vale
2626
run: |
2727
git clone https://github.com/errata-ai/Microsoft.git
2828
cp -r ./Microsoft/Microsoft ./styles
2929
VALEFILES=$(find -L ./docs/ -type d \( -path "./docs/plone.restapi/lib/*" -o -path "./docs/plone.restapi/performance/*" \) -prune -false -o -type f -name "*.md" -print)
3030
vale --no-exit $VALEFILES
31+
32+
- name: Check for broken links
33+
run: make linkcheck

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ changes: deps
189189

190190
.PHONY: linkcheck
191191
linkcheck: deps ## Run linkcheck
192-
cd $(DOCS_DIR) && $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
192+
cd $(DOCS_DIR) && $(SPHINXBUILD) -b linkcheck -W $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
193193
@echo "Link check complete; look for any errors in the above output " \
194194
"or in $(BUILDDIR)/linkcheck/ ."
195195
@echo

‎docs/backend/upgrading/version-specific-migration/upgrade-to-52.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Nothing changes.
162162
You can now use a RESTful hypermedia API for Plone to build modern JavaScript frontends on top of Plone.
163163
Also, the REST API can be used to import or export data.
164164

165-
See https://plonerestapi.readthedocs.io/en/latest/ for details.
165+
See {doc}`/plone.restapi/docs/source/index` for details.
166166

167167

168168
### New navigation with dropdown

‎docs/backend/upgrading/version-specific-migration/upgrade-to-60.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Plone 6.0 means we move from Zope 4 to 5.
148148
This drops support for Python 2.7, drops `ZServer`, and removes deprecated code.
149149

150150
```{seealso}
151-
[Zope 5.0a1](https://zope.readthedocs.io/en/latest/changes.html#a1-2020-02-28)
151+
[Zope 5.0a1](https://zope.readthedocs.io/en/5.x/changes.html#a1-2020-02-28)
152152
```
153153

154154
Some imports may need to change.

‎docs/classic-ui/templates.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ myst:
1414
Page Templates are the primary way to generate HTML output in Plone Classic UI.
1515
They are HTML files enhanced with special attributes written in TAL (Template Attribute Language), TALES (TAL Expression Syntax), and METAL (Macro Expansion for TAL).
1616

17-
Plone uses [Chameleon](https://chameleon.readthedocs.io/) as its template engine, integrated through the Zope framework.
17+
Plone uses [Chameleon](https://chameleon.readthedocs.io/en/latest/) as its template engine, integrated through the Zope framework.
1818
Chameleon is a fast HTML/XML template engine that implements the ZPT (Zope Page Templates) specification with additional features.
1919

2020

@@ -970,5 +970,5 @@ import pdb; pdb.set_trace()
970970
- {doc}`views`
971971
- {doc}`viewlets`
972972
- {doc}`template-global-variables`
973-
- [Chameleon documentation](https://chameleon.readthedocs.io/)
973+
- [Chameleon documentation](https://chameleon.readthedocs.io/en/latest/)
974974
- {doc}`training-2023:mastering-plone-5/zpt`

‎docs/conf.py‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,21 +93,23 @@
9393
r"https://classic.demo.plone.org/en/demo/an-image.jpg/@@images-test#srcset",
9494
r"https://javascript.plainenglish.io/you-dont-need-lodash-how-i-gave-up-lodash-693c8b96a07c",
9595
# Ignore pages that are rate limited or otherwise blocked
96+
r"https://codesandbox.io/",
97+
r"https://docutils.sourceforge.io/",
98+
r"https://hosted.weblate.org/",
99+
r"https://medium.com",
100+
r"https://pastanaga.io",
96101
r"https://stackoverflow.com",
102+
r"https://v5.reactrouter.com",
103+
r"https://www.merriam-webster.com/",
97104
r"https://www.npmjs.com/",
98-
r"https://hosted.weblate.org/",
99105
# Ignore github.com pages with anchors
100106
r"https://github.com/.*#.*",
101-
# Ignore rate limiting by github.com
107+
# Ignore redirects and rate limiting by github.com
102108
r"https://github.com/plone/volto/issues",
103109
r"https://github.com/plone/volto/pull",
104110
# Ignore other specific anchors
105-
r"https://coveralls.io/repos/github/plone/plone.restapi/badge.svg\?branch=main", # plone.restapi
106-
r"https://hosted.weblate.org/accounts/profile/#notifications",
107111
r"https://browsersl.ist/#", # volto
108-
# Ignore unreliable sites
109-
r"https://.*.gnu.org/",
110-
# fluke where Sphinx interprets this as a URL
112+
# fluke where Sphinx MyST linkify extension interprets this as a URL
111113
r"http://z3c.pt",
112114
]
113115
linkcheck_allowed_redirects = {

‎docs/contributing/documentation/authors.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ make vale VALEOPTS="--minAlertLevel='warning'" VALEFILES="docs/index.md"
121121

122122
The command `make vale` automatically installs Vale into your Python virtual environment—which is also created via any documentation `Makefile` commands—when you invoke it for the first time.
123123

124-
Vale has [integrations](https://vale.sh/docs/) with various IDEs.
124+
Vale has [integrations](https://docs.vale.sh/) with various IDEs.
125125
Integration might require installing Vale using operating system's package manager.
126126

127127
- [JetBrains](https://plugins.jetbrains.com/plugin/19613-vale-cli/docs)
@@ -357,7 +357,7 @@ The Plone Documentation Team adopted additional guidelines.
357357

358358
The reviewer can't give targeted feedback for a single sentence when there are multiple sentences on one line.
359359

360-
When a single sentence is broken across multiple lines, the reviewer may not know that they can submit [one suggestion for multiple lines](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-comments-to-a-pull-request).
360+
When a single sentence is broken across multiple lines, the reviewer may not know that they can submit [one suggestion for multiple lines](https://docs.github.com/en/pull-requests/how-tos/review-pull-requests/commenting-on-a-pull-request#adding-comments-to-a-pull-request).
361361
Instead, they either make a comment or a single suggestion leaving the author to manually edit the lines.
362362
This in turn deprives you of the easy option to commit the suggestion to the pull request by a single click of a button in the GitHub user interface.
363363

‎docs/contributing/documentation/myst-reference.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ For an in depth discussion of privacy issues, see [How to embed YouTube videos w
310310

311311
You can use [Mermaid](https://mermaid.js.org/) and its Sphinx extension [`sphinxcontrib.mermaid`](https://pypi.org/project/sphinxcontrib-mermaid/) to render graphs in your documents, including general flowcharts, sequence diagrams, and Gantt charts.
312312

313-
You can use the [Mermaid Playground](https://www.mermaidchart.com/play) to compose Mermaid markup and preview a live diagram.
313+
You can use the [Mermaid Playground](https://mermaid.ai/live/edit) to compose Mermaid markup and preview a live diagram.
314314

315315
````{example}
316316
```{mermaid}

‎docs/contributing/first-time.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,9 @@ You will pull code from the upstream Plone repository, push your work from your
227227
_Plone git workflow_
228228
````
229229
230-
1. Start by [forking the project's repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) to your account through the GitHub interface.
231-
1. [Clone your forked repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#cloning-your-forked-repository).
232-
1. [Configure git to sync your fork with the upstream repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository).
230+
1. Start by [forking the project's repository](https://docs.github.com/en/pull-requests/how-tos/work-with-forks/fork-a-repo) to your account through the GitHub interface.
231+
1. [Clone your forked repository](https://docs.github.com/en/pull-requests/how-tos/work-with-forks/fork-a-repo#cloning-your-forked-repository).
232+
1. [Configure git to sync your fork with the upstream repository](https://docs.github.com/en/pull-requests/how-tos/work-with-forks/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository).
233233
234234
235235
(write-code-label)=
@@ -291,7 +291,7 @@ Once you have completed, tested, and linted your code, and created a {ref}`contr
291291
git push -u origin my-branch-name
292292
```
293293
294-
1. Visit your fork of the Plone repository on GitHub, and [**create a pull request**](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) against the development branch.
294+
1. Visit your fork of the Plone repository on GitHub, and [**create a pull request**](https://docs.github.com/en/pull-requests/how-tos/create-pull-requests/creating-a-pull-request) against the development branch.
295295
- Make both your title and description descriptive.
296296
Reviewers look at many pull requests, and need to quickly understand the context.
297297
A lazily written phrase such as "Fixes bug" is meaningless.
@@ -305,7 +305,7 @@ Once you have completed, tested, and linted your code, and created a {ref}`contr
305305
306306
1. **Request a review.**
307307
Identify who you should ask by either checking the history of the files you edit, or viewing the project's list of contributors for an active member.
308-
If you have write access to the repository, [request a review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) from other team members.
308+
If you have write access to the repository, [request a review](https://docs.github.com/en/pull-requests/how-tos/create-pull-requests/requesting-a-pull-request-review) from other team members.
309309
If you do not have write access, instead add a comment and mention a few active contributors of the project, tagging them with `@username`.
310310
You can find them by either checking the files' history via `git blame` or visiting the project's {guilabel}`Contributors` page on GitHub.
311311
1. Members who subscribe to the repository will receive a notification and review your request.

‎docs/glossary.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ hoisting
350350
In case two dependencies have conflicting version dependencies of the same library, the hoisting will not be possible (for that conflicting dependency) and you'll see multiple instances of the same library in the bundle, or you'll see that the add-on receives its own `node_modules` folder.
351351
352352
React
353-
[React](https://www.reactjs.dev/) is a JavaScript library for building user interfaces.
353+
[React](https://reactjs.dev/) is a JavaScript library for building user interfaces.
354354
Volto, the frontend for Plone 6, uses React.
355355
356356
Sphinx

0 commit comments

Comments
 (0)