Contributing review linkcheck

.github/CONTRIBUTING.md

@@ -1 +1 @@
-See our [contributing guidelines](https://training.plone.org/about/).
+See our [contributing guidelines](https://training.plone.org/5/contributing/index.html).

README.rst

@@ -25,7 +25,7 @@ Different Plone Trainings:
 Documentation
 =============
 
-Documentation on how to use, build and contribute to the trainings can be found on the `Training Website <https://training.plone.org/5/mastering-plone/about_mastering.html>`_ .
+Documentation on how to use, build and contribute to the trainings can be found on the `Training Website <https://training.plone.org/5/contributing/index.html>`_ .
 
 
 The landing page
@@ -50,5 +50,5 @@ If you are having issues, please let us know by opening an issue in our `Issue T
 License
 =======
 
-The project is licensed under the `Creative Commons Attribution 4.0 International License <https://creativecommons.org/licenses/by/4.0/>`_ by the `Plone Foundation <https://plone.org>`_
+The project is licensed under the `Creative Commons Attribution 4.0 International License <https://creativecommons.org/licenses/by/4.0/>`_ by the `Plone Foundation <https://plone.org>`_.
 

docs/Makefile

@@ -39,9 +39,9 @@ help:
 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
-	@echo "  spellcheck    to run spellcheck against the documentation (if enabled)"
-	@echo "  test	   run spell and link check in order to test"
-	@echo "  deploy    run clean and html, to get a clean build"
+	@echo "  spellcheck to run spellcheck against the documentation (if enabled)"
+	@echo "  test       to run spell and link check in order to test"
+	@echo "  deploy     to run clean and html, to get a clean build"
 	@echo "  presentation   to make HTML in presentation mode"
 
 .PHONY: clean
@@ -192,14 +192,14 @@ linkcheck:
 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
-		"or in log/linkcheck/output.txt."
+		"or in $(BUILDDIR)/linkcheck/output.txt."
 
 .PHONY: spellcheck
 spellcheck:
-	LANGUAGE=$* $(SPHINXBUILD) -b spelling -j 4 $(ALLSPHINXOPTS) log/spellcheck/$*
+	LANGUAGE=$* $(SPHINXBUILD) -b spelling -j 4 $(ALLSPHINXOPTS) $(BUILDDIR)/spellcheck/$*
 	@echo
 	@echo "Spellcheck is finished; look for any errors in the above output " \
-		" or in log/spellcheck/output.txt."
+		" or in $(BUILDDIR)/spellcheck/output.txt."
 
 .PHONY: doctest
 doctest:
@@ -208,7 +208,7 @@ doctest:
 	      "results in $(BUILDDIR)/doctest/output.txt."
 
 .PHONY: test
-test: clean
+test: clean linkcheck spellcheck
 
 .PHONY: deploy
 deploy: clean html

docs/_static/custom.css

@@ -190,4 +190,10 @@ main.bd-content #main-content dl.simple dt + dd {
   overflow-x: hidden;
   color: rgba(0,0,0,.65);
   border-radius: 10px;
+}
+
+/* Local navigation */
+li.nav-item.toc-entry {
+  line-height: 1.25em;
+  margin-bottom: 0.25em;
 }

docs/angular/configuration.md

@@ -55,7 +55,7 @@ That's how collective.themesitesetup gets enabled.
 Now we need to save our current Plone configuration into our theme.
 
 We need to use the `collective.themesitesetup` export feature available here:
-<http://whatever.herokuapp.com/Plone/++theme++plonecustom/@@export-site-setup>.
+`http://whatever.herokuapp.com/Plone/++theme++plonecustom/@@export-site-setup`.
 
 Obviously we do not need to export everything, in our current case we just want to get the comment feature related configuration and the content type configuration, so we just select `typeinfo` and `plone.app.registry`.
 

docs/conf.py

@@ -55,12 +55,12 @@
 # They can be extensions coming with Sphinx (named "sphinx.ext.*")
 # or your custom ones.
 extensions = [
-    "sphinx_copybutton",
-    "sphinx.ext.intersphinx",
+    "myst_parser",
     "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
+    "sphinx_copybutton",
     "sphinxcontrib.spelling",
-    "myst_parser",
 ]
 
 # For more information see:
@@ -73,6 +73,13 @@
                     #  instead of ```.
 ]
 
+# If true, the Docutils Smart Quotes transform, originally based on SmartyPants
+# (limited to English) and currently applying to many languages, will be used
+# to convert quotes and dashes to typographically correct entities.
+# Note to maintainers: setting this to `True` will cause contractions and
+# hyphenated words to be marked as misspelled by spellchecker.
+smartquotes=False
+
 # The name of the Pygments (syntax highlighting) style to use.
 # pygments_style = "sphinx.pygments_styles.PyramidStyle"
 pygments_style = "sphinx"
@@ -82,29 +89,19 @@
 linkcheck_ignore = [
     r"http://localhost:\d+",
     r"http://127.0.0.1:8080",
-    r"http://wiki.apache.org",
-    r"https://wiki.apache.org",
-    r"https://www.vagrantup.com",
-    r"https://www.dipf.de/en/research/projects",
-    r"http://whatever.herokuapp.com",
     r"http://example.com",
-    r"http://lorempixel.com",
-    r"https://plonedemo.kitconcept.com/en/@search",
-    r"https://www.packtpub.com",
-    r"https://lucidworks.com",
-    r"https://twitter.com",  # linkcheck redirects to mobile version
+    r"https://github.com/plone/training/issues/new/choose",  # requires auth
     r"https://www.linode.com",  # linkcheck makes a HEAD request, which is 403
 ]
 linkcheck_anchors = False
-linkcheck_timeout = 30
+linkcheck_timeout = 5
 
 # This is our wordlist with know words, like Github or Plone ...
 spelling_word_list_filename = "spelling_wordlist.txt"
 spelling_ignore_pypi_package_names = True
 
 # The suffix of source filenames.
 source_suffix = {
-    ".rst": "restructuredtext",
     ".md": "markdown",
 }
 
@@ -118,19 +115,7 @@
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = [
-    ".github/CONTRIBUTING.md",
-    "CHANGES.rst",
-    "README.rst",
-    "_build",
-    "bin",
-    "env",
-    "include",
-    "lib",
-    "local",
-    "log",
     "spelling_wordlist.txt",
-    "node_modules",
-    "about.md",
 ]
 
 
@@ -154,6 +139,8 @@
 
 html_theme_options = {
     "repository_url": "https://github.com/plone/training",
+    "repository_branch": "main",
+    "path_to_docs": "docs",
     "use_repository_button": True,
     "use_issues_button": True,
     "use_edit_page_button": True,