-
Notifications
You must be signed in to change notification settings - Fork 339
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
Add documentation for releasing GOV.UK Frontend from a support branch #2415
Conversation
@EoinShaughnessy Does this need to go through pre-i/2i? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These links can be relative
9c97fee
to
f1e62d7
Compare
f1e62d7
to
3ce7af9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of extra snags:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apart from the issues above, this looks good to me 👍
Thank you for organising this and putting it together 🙌
3ce7af9
to
cbfea16
Compare
@vanitabarrett Yeah, this should probably go through pre-i and 2i. Even if we're the ones using it, it might yet reach eyes outside of the team (like if we ever surface it in the Tech Docs Template). If that sounds ok, I'll ask for pre-i/2i. |
Sounds good to me, thanks @EoinShaughnessy ! |
Have sent content for pre-i. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vanitabarrett If you un-assign me as a reviewer, will that allow me to commit suggestions into the doc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have suggested a few small changes and made some comments.
4bc9fc8
to
37c5298
Compare
6ea116c
to
98c5ed2
Compare
@vanitabarrett Doc has passed 2i. Before we merge this - should the doc title match the filename? Currently, the doc title (i.e., displayed at the top of the doc) is 'Publish GOV.UK Frontend when |
Thanks @EoinShaughnessy ! Yeah I wasn't too sure on the best filename for this to be honest. Trying to make "Publish GOV.UK Frontend when main branch has unreleasable changes" into a filename seemed a bit difficult 😅 |
@vanitabarrett Ha, yeah tricky alright! Have changed doc title to match filename. Hope that's ok. Did this because:
|
b21d4aa
to
b3ac1e0
Compare
Thanks @EoinShaughnessy , seems sensible. Do you think we still need that second heading 'publish GOV.UK Frontend from a support branch' in that case? |
@vanitabarrett You're right, that heading can go. I've deleted it and made the headings after it into either H2s (if they were H3s before) or H3s (if they were H4s before). |
Closes #1958 Documentation for releasing a patch fix (e.g: urgent or security fix) when there are unreleased changes on `main` that can't go out yet.
6149e25
to
3a1b813
Compare
Closes #1958
Documentation for releasing a patch fix (e.g: urgent or security fix) when there are unreleased changes on
main
that can't go out yet. This process was trialled for the 3.14.0 release in an artificial scenario (in reality, we'd likely only follow this process for patch fixes)