Skip to content

Commit b3fd198

Browse files
authored
Merge branch '6.0' into rohnsha0-control-panel
2 parents d1175d5 + 3ca0db3 commit b3fd198

File tree

8 files changed

+36
-24
lines changed

8 files changed

+36
-24
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ clean: ## Clean docs build directory
3030
cd $(DOCS_DIR) && rm -rf $(BUILDDIR)/
3131

3232
.PHONY: distclean
33-
distclean: clean ## Clean docs build directory, Python virtual environment, and symlinks
33+
distclean: clean ## Clean Python virtual environment and symlinks to submodules
3434
rm -rf venv
3535
rm docs/plone.api
3636
rm docs/plone.restapi
3737
rm docs/volto
38-
@echo "Cleaned docs build directory, Python virtual environment, and symlinks."
38+
@echo "Cleaned Python virtual environment and symlinks to submodules."
3939
@echo
4040

4141
venv/bin/python: ## Setup up Python virtual environment and install requirements

docs/backend/workflows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ myst:
1212
# Workflows
1313

1414
```{seealso}
15-
See the training {ref}`training:workflow-label`.
15+
See the training {ref}`training-2024:workflow-label`.
1616
```
1717

1818
```{todo}

docs/conf.py

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@
7979
# Ignore localhost
8080
linkcheck_ignore = [
8181
# Ignore local and example URLs
82-
r"http://0.0.0.0",
8382
r"http://127.0.0.1",
8483
r"http://localhost",
8584
r"http://yoursite",
@@ -89,26 +88,19 @@
8988
# Ignore pages that require authentication
9089
r"https://github.com/orgs/plone/teams/", # requires auth
9190
r"https://github.com/plone/documentation/issues/new", # requires auth
92-
r"https://github.com/plone/volto/issues/new/choose", # requires auth
93-
r"https://opensource.org/", # requires auth
9491
# Ignore github.com pages with anchors
9592
r"https://github.com/.*#.*",
96-
# Ignore github.com searches
97-
r"https://github.com/search",
98-
# Ignore GitHub 429 Client Error: Too Many Requests for url
99-
r"https://github.com/collective/plone.app.locales/commits/master/",
10093
# Ignore rate limiting by github.com
10194
r"https://github.com/plone/volto/issues",
10295
r"https://github.com/plone/volto/pull",
10396
# Ignore other specific anchors
10497
r"https://coveralls.io/repos/github/plone/plone.restapi/badge.svg\?branch=main", # plone.restapi
105-
r"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors#Identifying_the_issue", # volto
106-
r"https://docs.cypress.io/guides/references/migration-guide#Migrating-to-Cypress-version-10-0", # volto
98+
r"https://hosted.weblate.org/accounts/profile/#notifications",
10799
r"https://browsersl.ist/#", # volto
108100
# Ignore unreliable sites
109-
r"https://web.archive.org/",
110-
r"https://www.gnu.org/", # Consider removal when upgrading Sphinx
111-
r"http://z3c.pt", # fluke where Sphinx interprets this as a URL
101+
r"https://.*.gnu.org/",
102+
# fluke where Sphinx interprets this as a URL
103+
r"http://z3c.pt",
112104
]
113105
linkcheck_allowed_redirects = {
114106
# All HTTP redirections from the source URI to the canonical URI will be treated as "working".

docs/contributing/core/release.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,6 @@ All files mentioned in this list may be written in Markdown or reStructuredText
3535
The `.mo` files can be created with the `zest.pocompile` add-on, which should be installed together with `zest.releaser`.
3636
- `.gitignore` and `MANIFEST.in` must reflect the files going in to the package (must include page template and `.po` files).
3737

38-
```{seealso}
39-
[High quality automated package releases for Python with `zest.releaser`](https://opensourcehacker.com/2012/08/14/high-quality-automated-package-releases-for-python-with-zest-releaser/).
40-
```
41-
4238

4339
## Special packages
4440

docs/contributing/documentation/authors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ This renders in the HTML `<head>` section as follows.
315315
<meta content="Plone, Documentation, SEO, meta, Vale, spell, grammar, style, check, linkcheck, lexer" name="keywords" />
316316
```
317317

318-
Additional {term}`Open Graph` metadata is implemented through the Sphinx extension [`sphinxext-opengraph`](https://github.com/wpilibsuite/sphinxext-opengraph) and the [MyST `html_meta` directive](https://myst-parser.readthedocs.io/en/latest/configuration.html#setting-html-metadata), which resolves to the [Docutils `meta` directive](https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata).
318+
Additional {term}`Open Graph` metadata is implemented through the Sphinx extension [`sphinxext-opengraph`](https://github.com/sphinx-doc/sphinxext-opengraph) and the [MyST `html_meta` directive](https://myst-parser.readthedocs.io/en/latest/configuration.html#setting-html-metadata), which resolves to the [Docutils `meta` directive](https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata).
319319
See the site-wide configuration in {file}`conf.py`.
320320

321321

docs/contributing/first-time.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ As a first-time contributor to Plone on GitHub, we expect that you have:
4242
- read and followed the guidance on the pages under {doc}`/contributing/index` both for Plone in general and for the specific project to which you want to contribute, as well as all the guidance on this page
4343
- worked through some trainings, such as the recommended:
4444
- {doc}`training:mastering-plone/index`
45-
- {doc}`training:volto-customization/index`
4645
- {doc}`training:customizing-volto-light-theme/index`
47-
- {doc}`training:voltohandson/index`
48-
- {doc}`training:voltoaddons/index`
46+
- {doc}`training:volto-customization/index`
4947
- {doc}`training:plone-deployment/index`
48+
- {doc}`training-2024:voltohandson/index` (archived)
49+
- {doc}`training-2024:voltoaddons/index` (archived)
5050
- a sincere interest to contribute to Plone and become an ongoing contributing member of our organization
5151
- a GitHub account
5252
- basic knowledge of using git and GitHub

docs/glossary.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -895,4 +895,28 @@ Higher-Order Component
895895
https://legacy.reactjs.org/docs/higher-order-components.html
896896
```
897897
898+
Mocha
899+
[Mocha](https://mochajs.org/) is a feature-rich JavaScript test framework running on {term}`Node.js` and in the browser, making asynchronous testing simple and fun.
900+
901+
Chai
902+
[Chai](https://www.chaijs.com/) Chai is a {term}`BDD` and {term}`TDD` assertion library for {term}`Node.js` and the browser that can be delightfully paired with any JavaScript testing framework.
903+
904+
Behavior-Driven Development
905+
BDD
906+
Behavior-Driven Development (BDD) is a software development approach that originated from Test-Driven Development (TDD).
907+
It emphasizes collaboration among developers, testers, and non-technical stakeholders to ensure the developed software meets the desired behavior (or functionality).
908+
909+
In BDD, the focus is on defining the behavior of a system in a human-readable language, often using a domain-specific language.
910+
This language is typically structured in a way that allows it to serve as both documentation and executable tests.
911+
BDD scenarios are written in plain language that describe how the system should behave in different situations.
912+
913+
Test-Driven Development
914+
TDD
915+
Test-Driven Development (TDD) is a technique for building software that guides software development by writing tests.
916+
It follows three steps repeatedly:
917+
918+
- Write a test for the next bit of functionality you want to add.
919+
- Write the functional code until the test passes.
920+
- Refactor both new and old code to make it well structured.
921+
898922
```

submodules/volto

Submodule volto updated 458 files

0 commit comments

Comments
 (0)