Skip to content
Merged
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 source/Development/TestSuites/multi-repo_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To test the UM, any changes to JULES, UKCA, Socrates, CASIM etc will also need
to be included. This is done by adding another source to the rose stem command
line.

1. :ref:`Checkout<checkout>` a UM working copy
1. Checkout` a UM working copy
- this may be your branch from a linked ticket, or a clean trunk copy
at either the last release or a suitable head of trunk revision.

Expand All @@ -50,7 +50,7 @@ Paths to the other codebases involved should be added to
``dependencies.sh`` under each of the ``*_sources`` variables. Again
these paths can either be to local changes or those in the repository.

1. :ref:`Checkout<checkout>` an LFRic Apps working copy
1. Checkout an LFRic Apps working copy

- this may be your branch from a linked ticket, or a clean trunk copy
at either the last release or a suitable head of trunk revision.
Expand Down
4 changes: 2 additions & 2 deletions source/WorkingPractices/multi_repository.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ will need testing with both the UM and LFRic Apps to check for any interactions.
Preparing Linked Tickets
------------------------
Every repository in a set of linked changes requires a ticket. Guidance on
setting these up can be found in :ref:`ticket`. These tickets will be treated
setting these up can be found in ticket. These tickets will be treated
as a group with the same reviewers and committed at the same time.

Do:
* Make sure every ticket has a cross reference to the others in the set, e.g. ``um:#1234``
* Use :ref:`keywords` to show which other repositories are involved
* Use keywords to show which other repositories are involved
* Get the tickets ready for review at the same time
* Ask for help testing if you don't have access to all the codebases involved

Expand Down
17 changes: 15 additions & 2 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Simulation Systems Working Practices
====================================

**These pages describe the working practices of the following simulation and
model codes owned by the Met Office; UM, LFRic Applications, JULES and UKCA.**
model codes owned by the Met Office:** `LFRic Applications`_, `LFRic Core`_, `UM`_, `JULES`_, `SOCRATES`_,
`CASIM`_ and `UKCA`_.

This includes how to get started, key points on developing your change and how
to test those developments. There is guidance on making changes that span multiple
Expand Down Expand Up @@ -111,4 +112,16 @@ and how to commit to the trunk.
:hidden:
:caption: Further Details

FurtherDetails/index
FurtherDetails/index


More detailed, project specific, documentation is also available. See the wiki pages in each repository as well as
the :ref:`docs` page for more information on what is available and how to contribute to it.

.. _LFRic Applications: https://github.com/MetOffice/lfric_apps
.. _LFRic Core: https://github.com/MetOffice/lfric_core
.. _UM: https://github.com/MetOffice/um
.. _CASIM: https://github.com/MetOffice/casim
.. _JULES: https://github.com/MetOffice/jules
.. _SOCRATES: https://github.com/MetOffice/socrates
.. _UKCA: https://github.com/MetOffice/ukca