Merge pull request InsightSoftwareConsortium#4297 from thewtex/migrat…

…ion-guide-sphinx Migration guide sphinx
Kitware · Nov 8, 2023 · f73cd98 · f73cd98
2 parents 7610780 + 094213f
commit f73cd98
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 6 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,2 @@
+Please see the [ITK Code of
+Conduct](https://docs.itk.org/en/latest/contributing/code_of_conduct.html).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,2 @@
+Please see the [ITK Contributing
+Guide](https://docs.itk.org/en/latest/contributing/index.html).
diff --git a/Documentation/docs/index.md b/Documentation/docs/index.md
@@ -42,6 +42,7 @@ API <https://itk.org/Doxygen/html/index.html>
 Discussion <https://discourse.itk.org>
 Issue tracker <https://github.com/InsightSoftwareConsortium/ITK/issues>
 releases/index
+migration_guides/index
 contributing/code_of_conduct
 contributing/index
-```
+```
diff --git a/Documentation/docs/migration_guides/index.md b/Documentation/docs/migration_guides/index.md
@@ -0,0 +1,10 @@
+# Migration Guides
+
+These migration guides explain how to update major versions of ITK, whic may contain breaking changes to the API.
+
+```{toctree}
+:hidden:
+:maxdepth: 3
+
+itk_5_migration_guide
+```
diff --git a/Documentation/ITK5MigrationGuide.md → ...migration_guides/itk_5_migration_guide.md b/Documentation/ITK5MigrationGuide.md → ...migration_guides/itk_5_migration_guide.md
@@ -362,8 +362,8 @@ As implied above, the changes to SpatialObject are extensive.   They include the
 Class changes
 -------------
 
-[itk::FilterWatcher](../Modules/Core/TestKernel/include/itkFilterWatcher.h) was deleted.
-It should be replaced by [itk::SimpleFilterWatcher](../Modules/Core/Common/include/itkSimpleFilterWatcher.h).
+`itk::FilterWatcher` was deleted.
+It should be replaced by [itk::SimpleFilterWatcher](../../../Modules/Core/Common/include/itkSimpleFilterWatcher.h).
 
 `itksys::hash_map` has been removed. It should be replaced by `std::unordered_map`.
 
@@ -627,6 +627,6 @@ To resolve these errors, update the remote module's dependency specification in
 Update scripts
 --------------
 
-[Utilities/ITKv5Preparation](../Utilities/ITKv5Preparation/) directory contains
+[Utilities/ITKv5Preparation](https://github.com/InsightSoftwareConsortium/ITK/tree/master/Utilities/ITKv5Preparation) directory contains
 bash scripts which have been used to update ITK to version 5. These scripts
 can assist with updating external code bases to ITK 5 content and style.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Please see the [ITK Code of
		Conduct](https://docs.itk.org/en/latest/contributing/code_of_conduct.html).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Please see the [ITK Contributing
		Guide](https://docs.itk.org/en/latest/contributing/index.html).