Merge branch '6-dev' into portlets

Author: jensens

.github/workflows/build_deploy.yml

@@ -22,8 +22,8 @@ jobs:
           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

@@ -20,6 +20,14 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           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

.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 '\#\#'
@@ -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 -wi "broken\|redirect" | GREP_COLORS='0;31' grep -vi "https://github.com/plone/volto/issues/" --color=auto || 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
@@ -241,4 +241,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

@@ -0,0 +1,19 @@
+[
+    {
+        "name": "6 (stable)",
+        "version": "6.0",
+        "url": "https://6.docs.plone.org/"
+    },
+    {
+        "version": "5",
+        "url": "https://5.docs.plone.org/"
+    },
+    {
+        "version": "4",
+        "url": "https://4.docs.plone.org/"
+    },
+    {
+        "version": "3",
+        "url": "https://3.docs.plone.org/"
+    }
+]

docs/_static/switcher.json

@@ -0,0 +1,19 @@
+{% extends "!page.html" %}
+
+{%- block htmltitle %}
+<title>{{ title|striptags|e }}{%- for parent in parents %} – {{ parent.title }}{%- endfor %}{{ titlesuffix }}</title>
+{%- endblock %}
+
+{% block body %}
+<div>
+    <h1>Page not found</h1>
+    <p>Unfortunately we couldn't find the content you were looking for.</p>
+</div>
+
+<style>
+    /* Hide empty sub menu. */
+    .sticky-top .bd-toc {
+        visibility: hidden;
+    }
+</style>
+{% endblock %}

docs/_templates/404.html

@@ -4,12 +4,13 @@
 <title>{{ title|striptags|e }}{%- for parent in parents %} – {{ parent.title }}{%- endfor %}{{ titlesuffix }}</title>
 {%- endblock %}
 
+
 {% block footer %}
     <script type="text/javascript">
         $(document).ready(function() {
             // Hide empty sub menu.
-            if ($.trim($(".topbar-contents .bd-toc").html()) === "") {
-                $(".topbar-contents .bd-toc").css("visibility", "hidden");
+            if ($.trim($(".sticky-top .bd-toc").html()) === "") {
+                $(".sticky-top .bd-toc").css("visibility", "hidden");
             }
         });
     </script>