Skip to content

Add technical guide for JULES visibility change#623

Merged
James Bruten (james-bruten-mo) merged 23 commits into
MetOffice:mainfrom
Pierre-siddall:public-jules-visibility
May 6, 2026
Merged

Add technical guide for JULES visibility change#623
James Bruten (james-bruten-mo) merged 23 commits into
MetOffice:mainfrom
Pierre-siddall:public-jules-visibility

Conversation

@Pierre-siddall
Copy link
Copy Markdown
Contributor

@Pierre-siddall Pierre Siddall (Pierre-siddall) commented May 1, 2026

PR Summary

Code Reviewer: James Bruten (@james-bruten-mo)

This PR adds the technical guide for users to update their JULES fork after it is set to public visibility.

Code Quality Checklist

  • I have performed a self-review of my own code
  • I have locally built the documentation successfully, and the output of changed sections is as expected

Code Review

  • The changes are coherent and valid

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also requires a few other changes. In FurtherDetails/index.rst you need to add the page to the toctree.

In source/git_faq.rst we already have the beginnings of an answer on this topic. That should be changed so it just points to this page. But it also contains a 2nd option about contacting github support. We should include that on the page as an alternative.

Finally, please double check the output of the build. As it currently is, is clearly not right which is easy to check.

Comment thread source/FurtherDetails/visibility_change.rst Outdated
Comment thread source/FurtherDetails/visibility_change.rst Outdated
Comment thread source/FurtherDetails/visibility_change.rst Outdated
Comment thread source/FurtherDetails/visibility_change.rst Outdated

Once the repository is public, contributors must re-establish their forks to continue submitting pull requests.

**Step 1: Create a new public fork (you will need to delete or rename existing private fork)**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of bold facing the step headings, instead use #. will create a numbered list. So:

#. Create a new public fork
   
   * In order to do this you should first rename your existing fork, from the settings page of that fork.
   * Then :ref:`create a new fork <forking>`
   * This new fork will be public to match the MetOffice/Jules repository.

And then using #. similarly in the other steps

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>
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>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also copy/adapt the contact github support advice from https://github.com/MetOffice/simulation-systems/blob/main/source/git_faq.rst?plain=1#L53. Then the answer to that faq can just be modified to point at the new file, as in the recent changes


Once the repository is public, contributors must re-establish their forks to continue submitting pull requests.

# Create a new public fork (you will need to delete or rename existing private fork)**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be #. not just a # to format correctly. You'll also need to indent the contained text and code block. See https://github.com/MetOffice/simulation-systems/blob/main/source/Reviewers/howtocommit.rst?plain=1#L179 for an example

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of final tweaks

Comment thread source/git_faq.rst Outdated
Comment thread source/FurtherDetails/visibility_changes.rst Outdated
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>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good now

@james-bruten-mo James Bruten (james-bruten-mo) merged commit cc65eb1 into MetOffice:main May 6, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants