add definitions box #409
add definitions box #409
Conversation
| In the following Working Practices, we will endeavour to provide options for using the Github Web Interface and the ``gh`` cli where possible. Further information will be available in the github documentation. | ||
|
|
||
| To get started with the ``gh`` cli, see the `gh quickstart guide <https://docs.github.com/en/github-cli/github-cli/quickstart>`_ | ||
|
|
There was a problem hiding this comment.
Is it worth adding a link to the github glossary near this? Something like,
The github glossary https://docs.github.com/en/get-started/learning-about-github/github-glossary_ contains additional definitions to those below
There was a problem hiding this comment.
The mix of markdown and rst didn't work there! I had github glossary as a hyperlink!
| All general development for Simulation Systems Github repos will take place on forks of that repository. It is the responsibility of the developer to maintain their own fork. See :ref:`forking` for advice on forking. | ||
| All general development for Simulation Systems Github repositories will take place on forks of that repository. It is the responsibility of the developer to maintain their own fork. See :ref:`forking` for advice on forking. | ||
|
|
||
| The development cycle can be seen below. ``Upstream`` (blue) refers to parent repository, owned by the MetOffice github organisation. ``Downstream`` (grey) refers to the forked repository, owned by the developer. |
There was a problem hiding this comment.
Do we want to remove the hinting of colours? Or am I getting ahead of myself given this is likely not the final flow design?
There was a problem hiding this comment.
I figured the flow design was likely to change and we can always include a key in the picture or add a note with it around colours once the final thing was sorted.
Co-authored-by: James Bruten <109733895+james-bruten-mo@users.noreply.github.com>
Co-authored-by: James Bruten <109733895+james-bruten-mo@users.noreply.github.com>
Making the definitions we're using easier to find and adding some initial things to this box. If it gets too big we might want to consider moving it.
Also deleting the files that have been made redundant so far.