move documentation into own sub page of contrib guide IQSS#10531

pdurbin · Jun 12, 2024 · 0b7cb9f · 0b7cb9f
1 parent 22d9a20
commit 0b7cb9f
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 10 deletions.
diff --git a/doc/sphinx-guides/source/contributor/documentation.md b/doc/sphinx-guides/source/contributor/documentation.md
@@ -0,0 +1,28 @@
+# Writing Documentation
+
+Thank you for your interest in contributing documentation to Dataverse! Good documentation is absolutely critical to the success of a software project.
+
+```{contents} Contents:
+:local:
+:depth: 3
+```
+
+## Where the Source Files Live
+
+The source for the documentation is in the main "dataverse" GitHub repo under the "[doc][]" folder.
+
+[doc]: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source
+
+## Tools
+
+The {doc}`/developers/documentation` section of the Developer Guide has, for a long time, been the primary place to find information about the tools we use to write docs. We may move some of that content here, but until then, please visit that page.
+
+## Writing Style Guidelines
+
+Please observe the following when writing documentation:
+
+- Use American English spelling.
+- Use examples when possible.
+- Break up longer paragraphs.
+- Use "double quotes" instead of 'single quotes'.
+- Favor "and" (data and code) over slashes (data/code).
diff --git a/doc/sphinx-guides/source/contributor/index.md b/doc/sphinx-guides/source/contributor/index.md
@@ -30,17 +30,12 @@ If you do not receive a reply to your new issue or comment in a timely manner, p
 
 ## Documentation
 
-The source for the documentation is in the GitHub repo under the "[doc][]" folder. If you find a typo or inaccuracy or something to clarify, please send us a pull request! For more on the tools used to write docs, please see the {doc}`/developers/documentation` section of the Developer Guide.
+Documentation is such a large topic (and important!) that we have a dedicate section on it:
 
-Please observe the following when writing documentation:
-
-- Use American English spelling.
-- Use examples when possible.
-- Break up longer paragraphs.
-- Use "double quotes" instead of 'single quotes'.
-- Favor "and" (data and code) over slashes (data/code).
-
-[doc]: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source
+```{toctree}
+:maxdepth: 1
+documentation.md
+```
 
 ## Translations
 

diff --git a/doc/sphinx-guides/source/developers/documentation.rst b/doc/sphinx-guides/source/developers/documentation.rst
@@ -2,6 +2,8 @@
 Writing Documentation
 =====================
 
+Note: in the Contributor Guide, there is a section called :doc:`/contributor/documentation`.
+
 .. contents:: |toctitle|
 	:local: