docs: restructure contributing section (#1279)

* docs: restructure contributing section * add changelog news fragment
bjlittle · Jan 22, 2025 · 0ff1605 · 0ff1605
1 parent 1d7afc9
commit 0ff1605
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 7 deletions.
diff --git a/.github/scripts/changelog.py b/.github/scripts/changelog.py
@@ -26,7 +26,7 @@
 GITHUB_STEP_SUMMARY = os.getenv("GITHUB_STEP_SUMMARY")
 PATTERN = re.compile(r"^\d+$")
 PULL = "https://github.com/bjlittle/geovista/pull"
-URL = "https://geovista.readthedocs.io/en/latest/developer/index.html#changelog"
+URL = "https://geovista.readthedocs.io/en/latest/developer/towncrier.html#changelog"
 
 
 @dataclass

diff --git a/changelog/1072.documentation.rst b/changelog/1072.documentation.rst
@@ -1 +1 @@
-Added developer :ref:`changelog <gv-developer-changelog>` notes. (:user:`bjlittle`)
+Added :ref:`gv-developer-towncrier` contributor guidelines. (:user:`bjlittle`)
diff --git a/changelog/1080.documentation.rst b/changelog/1080.documentation.rst
@@ -1,2 +1,2 @@
-Updated the :ref:`gv-developer-changelog` contributor guidelines.
+Updated the :ref:`gv-developer-towncrier` contributor guidelines.
 (:user:`bjlittle`)
diff --git a/changelog/1279.contributor.rst b/changelog/1279.contributor.rst
@@ -0,0 +1 @@
+Restructured the :ref:`gv-developer` guidelines. (:user:`bjlittle`)
diff --git a/docs/src/developer/index.rst b/docs/src/developer/index.rst
@@ -17,13 +17,28 @@
 |Contributor Covenant|
 
 Firstly, and most importantly, thank you for contributing! All contributions, no
-matter how small, are greatly appreciated and welcomed.
+matter how large or small are greatly appreciated and welcomed.
 
 Here we provide some guidelines to help get you started on your journey, and
 clarify the various steps involved in how to contribute to ``geovista``.
 
+.. grid:: 1 1 2 2
+    :gutter: 2
 
-.. _gv-developer-changelog:
+    .. grid-item-card:: Changelog
+        :class-title: custom-title
+        :class-body: custom-body
+        :link: gv-developer-towncrier
+        :link-type: ref
+        :img-top: ../_static/images/icons/changelog.svg
+        :class-img-top: dark-light
+        :class-card: sd-rounded-3
 
-.. include:: changelog.md
-    :parser: myst_parser.sphinx_
+        Towncrier guidelines.
+
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    towncrier
diff --git a/docs/src/developer/towncrier.rst b/docs/src/developer/towncrier.rst
@@ -0,0 +1,4 @@
+.. _gv-developer-towncrier:
+
+.. include:: changelog.md
+    :parser: myst_parser.sphinx_
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Added developer :ref:`changelog <gv-developer-changelog>` notes. (:user:`bjlittle`)
		Added :ref:`gv-developer-towncrier` contributor guidelines. (:user:`bjlittle`)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Restructured the :ref:`gv-developer` guidelines. (:user:`bjlittle`)