From 4dc81eda2a3af96c8fbe508dfca8a76fe6216d6c Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 21 Nov 2024 02:51:29 -0800 Subject: [PATCH] Refactor documentation includes to align with main documentation pattern (#6495) --- .../branch-policy.md => _inc/_branch-policy.md} | 0 .../install-docker.md => _inc/_install-docker.md} | 0 .../install-git.md => _inc/_install-git.md} | 0 .../install-make.md => _inc/_install-make.md} | 0 .../install-nodejs.md => _inc/_install-nodejs.md} | 0 .../install-nvm.md => _inc/_install-nvm.md} | 0 .../_install-operating-system.md} | 0 docs/source/conf.py | 2 +- docs/source/contributing/developing-core.md | 12 ++++++------ docs/source/contributing/index.md | 2 +- docs/source/contributing/version-policy.md | 2 +- packages/volto/news/6495.documentation | 1 + 12 files changed, 10 insertions(+), 9 deletions(-) rename docs/source/{contributing/branch-policy.md => _inc/_branch-policy.md} (100%) rename docs/source/{contributing/install-docker.md => _inc/_install-docker.md} (100%) rename docs/source/{contributing/install-git.md => _inc/_install-git.md} (100%) rename docs/source/{contributing/install-make.md => _inc/_install-make.md} (100%) rename docs/source/{contributing/install-nodejs.md => _inc/_install-nodejs.md} (100%) rename docs/source/{contributing/install-nvm.md => _inc/_install-nvm.md} (100%) rename docs/source/{contributing/install-operating-system.md => _inc/_install-operating-system.md} (100%) create mode 100644 packages/volto/news/6495.documentation diff --git a/docs/source/contributing/branch-policy.md b/docs/source/_inc/_branch-policy.md similarity index 100% rename from docs/source/contributing/branch-policy.md rename to docs/source/_inc/_branch-policy.md diff --git a/docs/source/contributing/install-docker.md b/docs/source/_inc/_install-docker.md similarity index 100% rename from docs/source/contributing/install-docker.md rename to docs/source/_inc/_install-docker.md diff --git a/docs/source/contributing/install-git.md b/docs/source/_inc/_install-git.md similarity index 100% rename from docs/source/contributing/install-git.md rename to docs/source/_inc/_install-git.md diff --git a/docs/source/contributing/install-make.md b/docs/source/_inc/_install-make.md similarity index 100% rename from docs/source/contributing/install-make.md rename to docs/source/_inc/_install-make.md diff --git a/docs/source/contributing/install-nodejs.md b/docs/source/_inc/_install-nodejs.md similarity index 100% rename from docs/source/contributing/install-nodejs.md rename to docs/source/_inc/_install-nodejs.md diff --git a/docs/source/contributing/install-nvm.md b/docs/source/_inc/_install-nvm.md similarity index 100% rename from docs/source/contributing/install-nvm.md rename to docs/source/_inc/_install-nvm.md diff --git a/docs/source/contributing/install-operating-system.md b/docs/source/_inc/_install-operating-system.md similarity index 100% rename from docs/source/contributing/install-operating-system.md rename to docs/source/_inc/_install-operating-system.md diff --git a/docs/source/conf.py b/docs/source/conf.py index f2d9aed9a7..2080b93576 100644 --- 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 index f0507b2ede..f0ffb5462e 100644 --- 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 index cc6b8d03b2..46f2240f2b 100644 --- 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 index 19bac961b8..fe42d3d1d5 100644 --- 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 new file mode 100644 index 0000000000..ad974979eb --- /dev/null +++ b/packages/volto/news/6495.documentation @@ -0,0 +1 @@ +Refactor documentation includes to align with main documentation pattern. @stevepiercy