Merge pull request #4335 from thewtex/maint-docs

Maint docs
InsightSoftwareConsortium · Nov 18, 2023 · 8844ee6 · 8844ee6
2 parents ce7a53b + db4b1d2
commit 8844ee6
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 55 deletions.
diff --git a/Documentation/Maintenance/Introduction.md b/Documentation/Maintenance/Introduction.md
diff --git a/Documentation/Maintenance/Dashboard.md → Documentation/docs/contributing/dashboard.md b/Documentation/Maintenance/Dashboard.md → Documentation/docs/contributing/dashboard.md
@@ -2,7 +2,7 @@ ITK Dashboard Scripts
 =====================
 
 This page documents how to use the ITK `dashboard` branch in [Git]. See our
-[CONTRIBUTING](../CONTRIBUTING.md) guide for more information.
+[CONTRIBUTING](index.md) guide for more information.
 
 Using the dashboard scripts
 ---------------------------

diff --git a/Documentation/docs/contributing/index.md b/Documentation/docs/contributing/index.md
@@ -362,6 +362,26 @@ To connect your [ORCID](https://orcid.org/) profile to the [ITK Zenodo
 citation](https://zenodo.org/record/3592082), add your name and ORCID iD to
 the *ITK/.zenodo* file after contributing 10 or more commits.
 
+Branches
+--------
+
+At the time of this writing the `ITK` repository has the following
+branches:
+
+  * `master`: Development (default)
+  * `release`: Maintenance of latest release
+  * `release-3.20`: Maintenance of the ITKv3 series
+  * `release-4.13`: Maintenance of the ITKv4 series
+  * `5.4`: Maintenance of the ITKv5 series.
+    - The naming convention changed to support ReadTheDocs rendering of
+      versions on docs.itk.org
+    - Future releases, `6.0`, `6.1`, etc. should use this convention.
+  * `nightly-master`: Follows master, updated at 01:00 UTC for nightly dashboard build consistency.
+  * `hooks`: Local commit hooks (place in `.git/hooks`)
+  * `dashboard`: Dashboard script (setup a CDash client)
+
+Actual releases have tags named by the release version number.
+
 ```{toctree}
 :hidden:
 :maxdepth: 3
@@ -371,6 +391,8 @@ ITK Software Guide, Book 1, Part III: Development Guidelines <https://itk.org/It
 git_help.md
 GitHub flow guide <https://guides.github.com/introduction/flow/index.html>
 ITK Git Cheatsheet <https://github.com/InsightSoftwareConsortium/ITK/blob/master/Documentation/docs/contributing/GitCheatSheet.pdf>
+CDash Dashboard <https://open.cdash.org/index.php?project=Insight>
+dashboard.md
 updating_third_party.md
 data.md
 upload_binary_data.md

diff --git a/Documentation/docs/index.md b/Documentation/docs/index.md
@@ -43,7 +43,6 @@ learn/courses.md
 API <https://itk.org/Doxygen/html/index.html>
 Discussion <https://discourse.itk.org>
 Issue tracker <https://github.com/InsightSoftwareConsortium/ITK/issues>
-CDash Dashboard <https://open.cdash.org/index.php?project=Insight>
 supported_compilers
 migration_guides/index
 contributing/code_of_conduct