Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Toc #19

Merged
merged 11 commits into from
Sep 1, 2024
Merged

Toc #19

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/bioformats-release-process.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
38 changes: 38 additions & 0 deletions docs/build-and-release.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Build and Release
=================

The following sections summarize the development and release processes followed by the OME team.



Build
-----

.. toctree::
:maxdepth: 1

ansible-development
schema-changes
continuous-integration
data-model-schema
editing-docs
jekyll
development-tools
deployment-tools

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

18 changes: 0 additions & 18 deletions docs/components-release.rst

This file was deleted.

2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)

15 changes: 15 additions & 0 deletions docs/general.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
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
19 changes: 4 additions & 15 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,15 @@ 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.


.. 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
general
build-and-release
testing_scenarios/index


Information specific to developing OMERO, the OME Data Model and file formats,
and Bio-Formats can be found in their respective developer documentation
sections:
Expand Down
2 changes: 1 addition & 1 deletion docs/testing_scenarios/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Testing scenarios


.. toctree::
:maxdepth: 2
:maxdepth: 1
:numbered: 2

TablePermissionsUsers
Expand Down