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.

Sign up for GitHub

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

Jump to bottom

Reflect docs navigation structure change #387

Merged
merged 1 commit into from
Jun 28, 2024
Merged

Reflect docs navigation structure change #387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 12 additions & 8 deletions procedures/foreman/release.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,6 @@ Note: If for some reason there was an issue with the tarballs that required uplo
<% end -%>
- Make sure [foreman-contributors.adoc](https://github.com/theforeman/foreman-documentation/blob/<%= short_version %>/guides/doc-Release_Notes/topics/foreman-contributors.adoc) is updated
- Make sure headline features, upgrade warnings and deprecations are in sync with the website
<% if is_first_ga -%>
- Update `web/content/index.adoc` and `web/content/js/versions.js` to declare <%= short_version %> as stable and <%= short_version_minus_two %> as unsupported
<% elsif is_first_rc -%>
- Update `web/content/index.adoc` and `web/content/js/versions.js` to add <%= short_version %> as a release candidate
<% end -%>
- Submit this as a PR
<% if is_first_rc -%>
- [ ] [Generate](https://github.com/theforeman/apidocs#adding-new-version) the apipie docs and raise pull request in [apidocs](https://github.com/theforeman/apidocs) repository
Expand Down Expand Up @@ -150,9 +145,18 @@ Note: If for some reason there was an issue with the tarballs that required uplo
<% end -%>
<% end -%>
<% if is_first_ga -%>
- [ ] Update the [docs.theforeman.org](https://github.com/theforeman/foreman-documentation) [index page](https://github.com/theforeman/foreman-documentation/blob/master/web/content/index.adoc) and [versions](https://github.com/theforeman/foreman-documentation/blob/master/web/content/js/versions.js)
- Update <%= short_version %> as `supported`
- Update <%= short_version_minus_two %> as `unsupported`
- Update `web/content/index.adoc` and `web/content/js/versions.js` to declare <%= short_version %> as stable and <%= short_version_minus_two %> as unsupported
<% elsif is_first_rc -%>
- Update `web/content/index.adoc` and `web/content/js/versions.js` to add <%= short_version %> as a release candidate
<% end -%>
<% if is_first_rc -%>
- [ ] Add <%= short_version %> to the navigation in [docs.theforeman.org](https://github.com/theforeman/foreman-documentation) master
- `cp web/releases/nightly.adoc web/releases/<%= short_version %>.adoc` and modify as needed
- `cp web/releases/nightly.json web/releases/<%= short_version %>.json` and modify as needed
<% elsif is_first_ga -%>
- [ ] Update the [docs.theforeman.org](https://github.com/theforeman/foreman-documentation) master
- Update <%= short_version %> as `supported`: `sed -i '/"state":/ s/"[A-Za-z]\+",/"supported",/' web/releases/<%= short_version %>.json`
Copy link
Member Author

Choose a reason for hiding this comment

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

This was already a problem, but I noticed the navigation uses supported while the DocState (see below) is stable.

- Update <%= short_version_minus_two %> as `unsupported`: `sed -i '/"state":/ s/"[A-Za-z]\+",/"unsupported",/' web/releases/<%= short_version_minus_two %>.json`
- [ ] Update the [docs.theforeman.org](https://github.com/theforeman/foreman-documentation) <%= short_version %> DocState as `stable` in [attributes.adoc](https://github.com/theforeman/foreman-documentation/blob/<%= short_version %>/guides/common/attributes.adoc?plain=1): `sed -i '/:DocState:/ s/ .\+/ stable/' guides/common/attributes.adoc`
- [ ] Update the [docs.theforeman.org](https://github.com/theforeman/foreman-documentation) <%= short_version_minus_two %> DocState as `unsupported` in [attributes.adoc](https://github.com/theforeman/foreman-documentation/blob/<%= short_version_minus_two %>/guides/common/attributes.adoc?plain=1): `sed -i '/:DocState:/ s/ .\+/ unsupported/' guides/common/attributes.adoc`
<% end -%>
Expand Down
Loading