Merge branch '6-dev' into MrTango-views-templates

Author: MrTango

.github/workflows/build_deploy.yml

@@ -18,12 +18,12 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
+          pip install -q -r requirements-initial.txt
           pip install -q -r requirements.txt
           pip freeze
 
-      # - name: Run spellcheck
-      #   run: make spellcheck
+      # - name: Run Vale
+      #   run: make vale
 
       # - name: Run linkcheck
       #   run: make linkcheck

.github/workflows/test.yml

@@ -18,8 +18,16 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
+          pip install -q -r requirements-initial.txt
           pip install -q -r requirements.txt
+          sudo snap install --edge vale
 
       - name: Run tests with make test
         run: make test
+
+      - name: Run vale
+        run: |
+          git clone https://github.com/errata-ai/Microsoft.git
+          cp -r ./Microsoft/Microsoft ./styles
+          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)
+          vale --no-exit $VALEFILES

.github/workflows/update_submodule.yml

@@ -0,0 +1,30 @@
+name: Get latest version of submodules and push back to 6-dev branch
+
+on:
+  workflow_dispatch:
+
+jobs:
+  update_submodules:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout
+      - uses: actions/checkout@v3
+        with: 
+          ref: 6-dev
+          submodules: true
+
+      - name: Submodule update
+        run: |
+          git status
+          git submodule update --init --recursive
+          git submodule update --remote --recursive
+
+      - name: Commit updates
+        run: |
+          git status
+          git add submodules/plone.api submodules/plone.restapi submodules/volto
+          git status
+          git config user.name github-actions
+          git config user.email [email protected]
+          git commit -m "Update submo0dules tip" || echo "No changes to commit"
+          git push

.gitignore

@@ -7,6 +7,7 @@
 # Generated files
 pyvenv.cfg
 /_build
+/styles/Microsoft
 
 # symlinked from submodule
 docs/volto

.vale.ini

@@ -0,0 +1,10 @@
+StylesPath = styles
+
+MinAlertLevel = suggestion
+
+Vocab = Base,Plone
+
+Packages = Microsoft
+
+[*]
+BasedOnStyles = Vale, Microsoft

Makefile

@@ -16,7 +16,7 @@ PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
+VALEFILES       := $(shell find -L $(DOCS_DIR) -type d \( -path $(DOCS_DIR)/plone.restapi/lib/* -o  -path $(DOCS_DIR)"/plone.restapi/performance/*" \) -prune -false -o -type f -name "*.md" -print)
 
 # Add the following 'help' target to your Makefile
 # And add help text after each target name starting with '\#\#'
@@ -36,7 +36,7 @@ distclean:  ## Clean docs build directory and Python virtual environment
 
 bin/python:
 	python3 -m venv . || virtualenv --clear --python=python3 .
-	bin/python -m pip install --upgrade pip
+	bin/pip install -r requirements-initial.txt
 	bin/pip install -r requirements.txt
 
 docs/plone.api:
@@ -189,17 +189,17 @@ linkcheck: deps  ## Run linkcheck
 
 .PHONY: linkcheckbroken
 linkcheckbroken: deps  ## Run linkcheck and show only broken links
-	cd $(DOCS_DIR) && $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | GREP_COLORS='0;31' grep -wi "broken\|redirect" --color=auto || test $$? = 1
+	cd $(DOCS_DIR) && $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | GREP_COLORS='0;31' grep -wi "broken\|redirect" --color=always | GREP_COLORS='0;31' grep -vi "https://github.com/plone/volto/issues/" --color=always && if test $$? = 0; then exit 1; fi || test $$? = 1
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
 		"or in $(BUILDDIR)/linkcheck/ ."
 
-.PHONY: spellcheck
-spellcheck: deps  ## Run spellcheck
-	cd $(DOCS_DIR) && LANGUAGE=$* $(SPHINXBUILD) -b spelling -j 4 $(ALLSPHINXOPTS) $(BUILDDIR)/spellcheck/$*
+.PHONY: vale
+vale: deps  ## Run Vale style, grammar, and spell checks
+	vale sync
+	vale --no-wrap $(VALEFILES)
 	@echo
-	@echo "Spellcheck is finished; look for any errors in the above output " \
-		" or in $(BUILDDIR)/spellcheck/ ."
+	@echo "Vale is finished; look for any errors in the above output."
 
 .PHONY: html_meta
 html_meta: deps  ## Add meta data headers to all Markdown pages
@@ -212,7 +212,7 @@ doctest: deps
 	      "results in $(BUILDDIR)/doctest/output.txt."
 
 .PHONY: test
-test: clean linkcheckbroken spellcheck  ## Clean docs build, then run linkcheckbroken, spellcheck
+test: clean linkcheckbroken  ## Clean docs build, then run linkcheckbroken
 
 .PHONY: deploy
 deploy: clean html
@@ -226,6 +226,7 @@ livehtml: deps  ## Rebuild Sphinx documentation on changes, with live-reload in
 
 .PHONY: netlify
 netlify:
+	pip install -r requirements-initial.txt
 	pip install -r requirements.txt
 	pip install -r requirements-netlify.txt
 	git submodule init; \
@@ -241,4 +242,4 @@ storybook:
 	cd submodules/volto && yarn && yarn build-storybook -o ../../_build/html/storybook
 
 .PHONY: all
-all: clean spellcheck linkcheck html  ## Clean docs build, then run linkcheck and spellcheck, and build html
+all: clean vale linkcheck html  ## Clean docs build, then run vale and linkcheck, and build html

README.md

@@ -7,21 +7,21 @@ This is the repository for Plone Documentation.
 
 ## Plone 6
 
-Browse the Plone 6 Documentation at https://6.dev-docs.plone.org/.
+Browse the Plone 6 Documentation at https://6.docs.plone.org/.
 
 Active development on the Plone 6 Documentation takes place on the branch [`6-dev`](https://github.com/plone/documentation/tree/6-dev).
 
 
 ## Plone 5.2
 
-Browse the Plone 5.2 Documentation at https://docs.plone.org/.
+Browse the Plone 5.2 Documentation at https://5.docs.plone.org/.
 
 Development on the Plone 5.2 Documentation takes place on the branch [`5.2`](https://github.com/plone/documentation/tree/5.2).
 
 
 ## Contribute
 
-- [Contributing to Plone 6 Documentation](https://6.dev-docs.plone.org/contributing/index.html)
+- [Contributing to Plone 6 Documentation](https://6.docs.plone.org/contributing/index.html)
 - [Release Plone 6 docs Project Board](https://github.com/orgs/plone/projects/12)
 - [Issue Tracker](https://github.com/plone/documentation/issues)
 - [Source Code](https://github.com/plone/documentation/tree/6-dev)
@@ -37,7 +37,7 @@ Those packages include:
 - [`plone.restapi`](https://github.com/plone/plone.restapi)
 
 To contribute documentation, please open a pull request in the appropriate repository.
-For details, see [Editing external package documentation](https://6.dev-docs.plone.org/contributing/index.html#contributing-editing-external-package-documentation-label).
+For details, see [Editing external package documentation](https://6.docs.plone.org/contributing/index.html#contributing-editing-external-package-documentation-label).
 
 
 ## Support

docs/_static/backend/control-panel-action-edit-settings.png

@@ -47,6 +47,7 @@ img {
 }
 
 figure img,
+img.figure,
 .figure img {
   box-shadow: 0 6px 24px 0 rgba(153, 153, 153, 0.3);
 }
@@ -126,22 +127,6 @@ div.section div.section div.section {
   margin-bottom: 1.5rem !important;
 }
 
-.admonition.toggle .admonition-title {
-  cursor: pointer;
-  display: flex;
-}
-
-.admonition.toggle .admonition-title::after {
-  content: "\f105";
-  font-weight: 900;
-  font-family: "Font Awesome 5 Free";
-  margin-left: auto;
-}
-
-.admonition.toggle .admonition-title.open::after {
-  content: "\f107";
-}
-
 /* admonition todo */
 .admonition.admonition-todo,
 div.admonition.admonition-todo {