Refactor documentation includes to align with main documentation patt…

…ern (#6495)
plone · Nov 21, 2024 · 4dc81ed · 4dc81ed
1 parent 7613635
commit 4dc81ed
Show file tree

Hide file tree

Showing 12 changed files with 10 additions and 9 deletions.
diff --git a/docs/source/contributing/branch-policy.md → docs/source/_inc/_branch-policy.md b/docs/source/contributing/branch-policy.md → docs/source/_inc/_branch-policy.md
diff --git a/docs/source/contributing/install-docker.md → docs/source/_inc/_install-docker.md b/docs/source/contributing/install-docker.md → docs/source/_inc/_install-docker.md
diff --git a/docs/source/contributing/install-git.md → docs/source/_inc/_install-git.md b/docs/source/contributing/install-git.md → docs/source/_inc/_install-git.md
diff --git a/docs/source/contributing/install-make.md → docs/source/_inc/_install-make.md b/docs/source/contributing/install-make.md → docs/source/_inc/_install-make.md
diff --git a/docs/source/contributing/install-nodejs.md → docs/source/_inc/_install-nodejs.md b/docs/source/contributing/install-nodejs.md → docs/source/_inc/_install-nodejs.md
diff --git a/docs/source/contributing/install-nvm.md → docs/source/_inc/_install-nvm.md b/docs/source/contributing/install-nvm.md → docs/source/_inc/_install-nvm.md
diff --git a/.../contributing/install-operating-system.md → .../source/_inc/_install-operating-system.md b/.../contributing/install-operating-system.md → .../source/_inc/_install-operating-system.md
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -118,7 +118,7 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = [
     "spelling_wordlist.txt",
-    "contributing/branch-policy.md",
+    "_inc/*",
 ]
 
 suppress_warnings = [

diff --git a/docs/source/contributing/developing-core.md b/docs/source/contributing/developing-core.md
@@ -76,7 +76,7 @@ Volto has the following folder structure.
 
 To set up a Volto core development environment, your system must satisfy the following prerequisites.
 
-```{include} ./install-operating-system.md
+```{include} ../_inc/_install-operating-system.md
 ```
 
 -   {term}`nvm`
@@ -94,7 +94,7 @@ When developing a project using Plone, Yarn or other package managers may be use
 
 ### nvm
 
-```{include} ./install-nvm.md
+```{include} ../_inc/_install-nvm.md
 ```
 
 
@@ -103,7 +103,7 @@ When developing a project using Plone, Yarn or other package managers may be use
 We recommend that you install Node.js using nvm.
 Alternatively you can install Node.js using Homebrew or other package installer.
 
-```{include} ./install-nodejs.md
+```{include} ../_inc/_install-nodejs.md
 ```
 
 
@@ -136,19 +136,19 @@ Compare the output to the [latest pnpm release number](https://www.npmjs.com/pac
 
 ### Make
 
-```{include} ./install-make.md
+```{include} ../_inc/_install-make.md
 ```
 
 
 ### Docker
 
-```{include} ./install-docker.md
+```{include} ../_inc/_install-docker.md
 ```
 
 
 ### Git
 
-```{include} ../contributing/install-git.md
+```{include} ../_inc/_install-git.md
 ```
 
 

diff --git a/docs/source/contributing/index.md b/docs/source/contributing/index.md
@@ -44,7 +44,7 @@ The Volto Team reviews pull requests only from people with a GitHub account who
 
 ## Branch policy
 
-```{include} ./branch-policy.md
+```{include} ../_inc/_branch-policy.md
 ```
 
 

diff --git a/docs/source/contributing/version-policy.md b/docs/source/contributing/version-policy.md
@@ -92,7 +92,7 @@ We do not guarantee that outdated browsers, such as Internet Explorer 11, are su
 
 ## Branch policy
 
-```{include} ./branch-policy.md
+```{include} ../_inc/_branch-policy.md
 ```
 
 

diff --git a/packages/volto/news/6495.documentation b/packages/volto/news/6495.documentation
@@ -0,0 +1 @@
+Refactor documentation includes to align with main documentation pattern. @stevepiercy