From f94da97f177e1a3908c51691724cefe50650ba7f Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Mon, 26 Aug 2024 14:26:23 +0100 Subject: [PATCH 01/11] re-organise --- docs/components-development.rst | 18 ++++++++++++ docs/general.rst | 18 ++++++++++++ docs/index.rst | 49 +++++++++++++++++++++++---------- 3 files changed, 70 insertions(+), 15 deletions(-) create mode 100644 docs/components-development.rst create mode 100644 docs/general.rst diff --git a/docs/components-development.rst b/docs/components-development.rst new file mode 100644 index 0000000..1af62a0 --- /dev/null +++ b/docs/components-development.rst @@ -0,0 +1,18 @@ +Components development +====================== + +The following sections summarize the development of the various components of the software stack. +Note this is not an exhaustive list of all components. + + +.. toctree:: + :maxdepth: 1 + + ansible-development + development-tools + deployment-tools + continuous-integration + editing-docs + jekyll + data-model-schema + schema-changes diff --git a/docs/general.rst b/docs/general.rst new file mode 100644 index 0000000..8b9363b --- /dev/null +++ b/docs/general.rst @@ -0,0 +1,18 @@ +General +======= + +The following sections summarize general work practises followed by the OME team. + + +.. toctree:: + :maxdepth: 1 + + source-code + using-git + code-contributions + cla + team-communication + team-workflow + continuous-integration + editing-docs + data-model-schema diff --git a/docs/index.rst b/docs/index.rst index ca54130..5a7ba8c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,26 +7,45 @@ consortium projects. It includes internal developer practices and workflows, standard procedures for tasks such as release, and other information which may be valuable to a wider audience. + +******* +General +******* + +.. toctree:: + :maxdepth: 1 + + general + + +*********** +Development +*********** + +.. toctree:: + :maxdepth: 1 + + components-development + +******* +Testing +******* + .. toctree:: :maxdepth: 1 - source-code - using-git - code-contributions - cla - team-communication - team-workflow - ansible-development - development-tools - deployment-tools - continuous-integration - editing-docs - jekyll - data-model-schema - schema-changes - components-release testing_scenarios/index +******* +Release +******* + +.. toctree:: + :maxdepth: 1 + + components-release + + Information specific to developing OMERO, the OME Data Model and file formats, and Bio-Formats can be found in their respective developer documentation sections: From ea10f25ef2108a40c3d8ff3847807fd4feedc790 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Mon, 26 Aug 2024 14:32:44 +0100 Subject: [PATCH 02/11] modify toc depth --- docs/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 5a7ba8c..b53389e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,7 +13,7 @@ General ******* .. toctree:: - :maxdepth: 1 + :maxdepth: 2 general @@ -23,7 +23,7 @@ Development *********** .. toctree:: - :maxdepth: 1 + :maxdepth: 2 components-development @@ -41,7 +41,7 @@ Release ******* .. toctree:: - :maxdepth: 1 + :maxdepth: 2 components-release From c5cc92548b3f6eef3840d1ade3a4f5ca59f216b7 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Mon, 26 Aug 2024 14:33:02 +0100 Subject: [PATCH 03/11] set up html theme --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index a325359..14c5f9d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -275,6 +275,8 @@ def copy_legacy_redirects(app, exception): print(" %s" % html_src_path) +html_theme = "sphinx_rtd_theme" + def setup(app): app.connect('build-finished', copy_legacy_redirects) From 79601468aaaa80e4f6c32de3d54ec85ce3a31acb Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Tue, 27 Aug 2024 09:23:39 +0100 Subject: [PATCH 04/11] do not combine entries --- docs/components-development.rst | 18 ------------------ docs/components-release.rst | 18 ------------------ docs/general.rst | 18 ------------------ docs/index.rst | 33 +++++++++++++++++++++++++++------ 4 files changed, 27 insertions(+), 60 deletions(-) delete mode 100644 docs/components-development.rst delete mode 100644 docs/components-release.rst delete mode 100644 docs/general.rst diff --git a/docs/components-development.rst b/docs/components-development.rst deleted file mode 100644 index 1af62a0..0000000 --- a/docs/components-development.rst +++ /dev/null @@ -1,18 +0,0 @@ -Components development -====================== - -The following sections summarize the development of the various components of the software stack. -Note this is not an exhaustive list of all components. - - -.. toctree:: - :maxdepth: 1 - - ansible-development - development-tools - deployment-tools - continuous-integration - editing-docs - jekyll - data-model-schema - schema-changes diff --git a/docs/components-release.rst b/docs/components-release.rst deleted file mode 100644 index 8315685..0000000 --- a/docs/components-release.rst +++ /dev/null @@ -1,18 +0,0 @@ -Components release -================== - -The following sections summarize the release process of the various components of the software stack. -Note this is not an exhaustive list of all tools release process. - - -.. toctree:: - :maxdepth: 1 - - bioformats-release-process - cpp-development - gradle-development - java-development - python-components - omero-release-process - omero-web-release-process - \ No newline at end of file diff --git a/docs/general.rst b/docs/general.rst deleted file mode 100644 index 8b9363b..0000000 --- a/docs/general.rst +++ /dev/null @@ -1,18 +0,0 @@ -General -======= - -The following sections summarize general work practises followed by the OME team. - - -.. toctree:: - :maxdepth: 1 - - source-code - using-git - code-contributions - cla - team-communication - team-workflow - continuous-integration - editing-docs - data-model-schema diff --git a/docs/index.rst b/docs/index.rst index b53389e..ed59ad9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,9 +13,17 @@ General ******* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - general + source-code + using-git + code-contributions + cla + team-communication + team-workflow + continuous-integration + editing-docs + data-model-schema *********** @@ -23,9 +31,16 @@ Development *********** .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - components-development + ansible-development + development-tools + deployment-tools + continuous-integration + editing-docs + jekyll + data-model-schema + schema-changes ******* Testing @@ -41,9 +56,15 @@ Release ******* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - components-release + bioformats-release-process + cpp-development + gradle-development + java-development + python-components + omero-release-process + omero-web-release-process Information specific to developing OMERO, the OME Data Model and file formats, From 874f5f55a0937e3d431460936d5031fd233c90aa Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Tue, 27 Aug 2024 09:42:29 +0100 Subject: [PATCH 05/11] re-organise toc and remove duplicate entries --- docs/index.rst | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index ed59ad9..78eb8fa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,15 +16,12 @@ General :maxdepth: 1 source-code - using-git code-contributions cla + deployment-tools team-communication team-workflow - continuous-integration - editing-docs - data-model-schema - + using-git *********** Development @@ -34,13 +31,12 @@ Development :maxdepth: 1 ansible-development - development-tools - deployment-tools + schema-changes continuous-integration + data-model-schema editing-docs jekyll - data-model-schema - schema-changes + development-tools ******* Testing @@ -62,9 +58,9 @@ Release cpp-development gradle-development java-development - python-components omero-release-process omero-web-release-process + python-components Information specific to developing OMERO, the OME Data Model and file formats, From e7db1a0b00bbd969adb1f2eb8429c4d0b53a317b Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Tue, 27 Aug 2024 10:05:07 +0100 Subject: [PATCH 06/11] fix typo --- docs/bioformats-release-process.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 2e206bc..d453145 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -1,5 +1,5 @@ -BioFormats release -================== +Bio-Formats release +=================== .. _Bio-Formats: https://github.com/ome/bioformats .. _Bio-Formats Documentation: https://github.com/ome/bio-formats-documentation From d9e7ac7bb9f236af4a8963e5a31e67ea2289d5d1 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Fri, 30 Aug 2024 13:34:30 +0100 Subject: [PATCH 07/11] Re-organise the toc --- docs/build-and-release.rst | 38 ++++++++++++++++++++++++++++ docs/general.rst | 18 ++++++++++++++ docs/index.rst | 51 ++------------------------------------ 3 files changed, 58 insertions(+), 49 deletions(-) create mode 100644 docs/build-and-release.rst create mode 100644 docs/general.rst diff --git a/docs/build-and-release.rst b/docs/build-and-release.rst new file mode 100644 index 0000000..2d93fe6 --- /dev/null +++ b/docs/build-and-release.rst @@ -0,0 +1,38 @@ +Build and Release +================= + +The following sections summarize the development and release processes followed by the OME team. + + + +Development +----------- + +.. toctree:: + :maxdepth: 1 + + ansible-development + development-tools + deployment-tools + continuous-integration + editing-docs + jekyll + data-model-schema + schema-changes + +Release +------- + +.. toctree:: + :maxdepth: 1 +.. toctree:: + :maxdepth: 1 + + bioformats-release-process + cpp-development + gradle-development + java-development + omero-release-process + omero-web-release-process + python-components + \ No newline at end of file diff --git a/docs/general.rst b/docs/general.rst new file mode 100644 index 0000000..92a9c13 --- /dev/null +++ b/docs/general.rst @@ -0,0 +1,18 @@ +Getting Started +=============== + +The following sections summarize general work practises followed by the OME team. + + +.. toctree:: + :maxdepth: 1 + + source-code + using-git + code-contributions + cla + team-communication + team-workflow + continuous-integration + editing-docs + data-model-schema diff --git a/docs/index.rst b/docs/index.rst index 78eb8fa..e5fee00 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,60 +8,13 @@ standard procedures for tasks such as release, and other information which may be valuable to a wider audience. -******* -General -******* - -.. toctree:: - :maxdepth: 1 - - source-code - code-contributions - cla - deployment-tools - team-communication - team-workflow - using-git - -*********** -Development -*********** - -.. toctree:: - :maxdepth: 1 - - ansible-development - schema-changes - continuous-integration - data-model-schema - editing-docs - jekyll - development-tools - -******* -Testing -******* - .. toctree:: :maxdepth: 1 + general + build-and-release testing_scenarios/index -******* -Release -******* - -.. toctree:: - :maxdepth: 1 - - bioformats-release-process - cpp-development - gradle-development - java-development - omero-release-process - omero-web-release-process - python-components - Information specific to developing OMERO, the OME Data Model and file formats, and Bio-Formats can be found in their respective developer documentation From 3c03b58ed379894acd892425d826f52b9d5eeec2 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Fri, 30 Aug 2024 14:05:09 +0100 Subject: [PATCH 08/11] Move entries out --- docs/general.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/general.rst b/docs/general.rst index 92a9c13..ca83f32 100644 --- a/docs/general.rst +++ b/docs/general.rst @@ -13,6 +13,3 @@ The following sections summarize general work practises followed by the OME team cla team-communication team-workflow - continuous-integration - editing-docs - data-model-schema From 58d91afe4884dbcfe445ce9bba1a9c927af62479 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Fri, 30 Aug 2024 14:08:23 +0100 Subject: [PATCH 09/11] Change the depth of the toc --- docs/testing_scenarios/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/testing_scenarios/index.rst b/docs/testing_scenarios/index.rst index 377cb75..3d595ba 100644 --- a/docs/testing_scenarios/index.rst +++ b/docs/testing_scenarios/index.rst @@ -8,7 +8,7 @@ Testing scenarios .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :numbered: 2 TablePermissionsUsers From 6dd8fbab6e5e6e6bf43296c6e13a1c0e27559b9b Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Fri, 30 Aug 2024 14:08:35 +0100 Subject: [PATCH 10/11] Re-order the dev section --- docs/build-and-release.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/build-and-release.rst b/docs/build-and-release.rst index 2d93fe6..6cab4ca 100644 --- a/docs/build-and-release.rst +++ b/docs/build-and-release.rst @@ -12,13 +12,13 @@ Development :maxdepth: 1 ansible-development - development-tools - deployment-tools + schema-changes continuous-integration + data-model-schema editing-docs jekyll - data-model-schema - schema-changes + development-tools + deployment-tools Release ------- From 42122076e412d747dce399b2e71c415eb395b643 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Fri, 30 Aug 2024 14:10:52 +0100 Subject: [PATCH 11/11] Replace dev by build --- docs/build-and-release.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build-and-release.rst b/docs/build-and-release.rst index 6cab4ca..6cea1bf 100644 --- a/docs/build-and-release.rst +++ b/docs/build-and-release.rst @@ -5,8 +5,8 @@ The following sections summarize the development and release processes followed -Development ------------ +Build +----- .. toctree:: :maxdepth: 1