diff --git a/Documentation/Maintenance/Introduction.md b/Documentation/Maintenance/Introduction.md deleted file mode 100644 index 2d308952e9f..00000000000 --- a/Documentation/Maintenance/Introduction.md +++ /dev/null @@ -1,53 +0,0 @@ -Introduction -============ - -ITK version tracking and development is hosted by [Git](https://git-scm.com/). -Please select a task for further instructions: - -Main Tasks ----------- - - * [Install Git](https://itk.org/Wiki/Git/Download) - Git 2.8.9 or greater is - preferred (required for development) - * [Download ITK] - Users start here - * [Develop ITK] - Contributors start here - -Other Tasks ------------ - - * [Test ITK] - CDash client setup - * [Learn Git](https://itk.org/Wiki/Git/Resources) - Third-party documentation - -*The remainder of this page provides reference information and links. It is -not intended to provide instructions.* - -Repositories ------------- - -One may browse the repositories online using the [GitHub] search interface at -[InsightSoftwareConsortium/ITK]. - -Branches --------- - -At the time of this writing the `ITK.git` 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 - * `nightly-master`: Follows master, updated at 01:00 UTC - * `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. - - -[Dashboard]: Dashboard.md -[Develop ITK]: CONTRIBUTING.md -[Download ITK]: Download.md -[InsightSoftwareConsortium/ITK]: https://github.com/InsightSoftwareConsortium/ITK -[Test ITK]: Dashboard.md - -[GitHub]: https://github.com/ diff --git a/Documentation/Maintenance/Dashboard.md b/Documentation/docs/contributing/dashboard.md similarity index 95% rename from Documentation/Maintenance/Dashboard.md rename to Documentation/docs/contributing/dashboard.md index 0c47e7f03a9..15b2cadb8e7 100644 --- a/Documentation/Maintenance/Dashboard.md +++ b/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 index 85a91e795cd..d0273235433 100644 --- 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 ITK Git Cheatsheet +CDash Dashboard +dashboard.md updating_third_party.md data.md upload_binary_data.md diff --git a/Documentation/docs/index.md b/Documentation/docs/index.md index d4974495f41..818af6d0fab 100644 --- a/Documentation/docs/index.md +++ b/Documentation/docs/index.md @@ -43,7 +43,6 @@ learn/courses.md API Discussion Issue tracker -CDash Dashboard supported_compilers migration_guides/index contributing/code_of_conduct