From af1fa27aeb8a9f270e08040679ccf402c701e9f2 Mon Sep 17 00:00:00 2001 From: Matt McCormick Date: Wed, 8 Nov 2023 10:38:04 -0500 Subject: [PATCH 1/2] DOC: Link to rendered docs for CODE_OF_CONDUCT.md, CONTRIBUTING.md The current symlinks do not redirect in the GitHub Web UI. --- CODE_OF_CONDUCT.md | 3 ++- CONTRIBUTING.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) mode change 120000 => 100644 CODE_OF_CONDUCT.md mode change 120000 => 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 120000 index a80ce0ba02d..00000000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1 +0,0 @@ -./Documentation/docs/contributing/code_of_conduct.md \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000000..6fd30a28ed4 --- /dev/null +++ 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 deleted file mode 120000 index 205abde9d80..00000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -Documentation/docs/contributing/index.md \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..867450dfed8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,2 @@ +Please see the [ITK Contributing +Guide](https://docs.itk.org/en/latest/contributing/index.html). From 094213f07617a15391fd8ea3582f905b24d35c9c Mon Sep 17 00:00:00 2001 From: Matt McCormick Date: Wed, 8 Nov 2023 10:58:51 -0500 Subject: [PATCH 2/2] DOC: Migrate the migration guide to Sphinx A folder is created in anticipation of the ITK 6 Migration Guide. A few links are updated in the guide, but the content is unchanged otherwise. --- Documentation/docs/index.md | 3 ++- Documentation/docs/migration_guides/index.md | 10 ++++++++++ .../migration_guides/itk_5_migration_guide.md} | 6 +++--- 3 files changed, 15 insertions(+), 4 deletions(-) create mode 100644 Documentation/docs/migration_guides/index.md rename Documentation/{ITK5MigrationGuide.md => docs/migration_guides/itk_5_migration_guide.md} (99%) diff --git a/Documentation/docs/index.md b/Documentation/docs/index.md index 7074b3ff814..bbc7eaa1887 100644 --- a/Documentation/docs/index.md +++ b/Documentation/docs/index.md @@ -42,6 +42,7 @@ API Discussion Issue tracker releases/index +migration_guides/index contributing/code_of_conduct contributing/index -``` \ No newline at end of file +``` diff --git a/Documentation/docs/migration_guides/index.md b/Documentation/docs/migration_guides/index.md new file mode 100644 index 00000000000..e841f12a150 --- /dev/null +++ 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 b/Documentation/docs/migration_guides/itk_5_migration_guide.md similarity index 99% rename from Documentation/ITK5MigrationGuide.md rename to Documentation/docs/migration_guides/itk_5_migration_guide.md index ed41848839b..884c93bb3e9 100644 --- a/Documentation/ITK5MigrationGuide.md +++ b/Documentation/docs/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.