-
Notifications
You must be signed in to change notification settings - Fork 14
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
chore(release): copy current docs to versioned 2.4.0 #178
chore(release): copy current docs to versioned 2.4.0 #178
Conversation
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.
Looks good! We should change the image names as well?
Which image names do you mean? I'm planning for this work to be done piecewise, like it was done last time around for 2.3.0->2.4.0, so further PRs to the same base branch can follow to do whatever content updates need to be done. |
* chore(release): copy current docs to versioned 2.4.0 (#178) * docs(guides): update guide for trusted TLS certs (#181) * docs(credentials): remove references to Session credentials storage (#182) * docs(grafana): remove references to separate login credentials (#183) * docs(versions): bump k8s and OpenShift min versions (#184) * feat(get-started): document Agent dynamic attach (#185) Co-authored-by: Atif Ali <atali@redhat.com> * fix(dashboard): fix image links and a typo on dashboard guide (#186) * fix(topology): remove outdated caution note (#187) * docs(guides): update guide for starting/stopping recordings (#190) * update screenshot * document 'restart if recording already exists' checkbox * add link to guide for creating custom event template * remove unnecessary formatting from term * docs(guides): update guide for download recording (#191) * link more tools * update screenshot * update file extension * remove JMC mention, already mentioned earlier in guide steps * docs(guides): update formatting in guide for editing template using JMC (#192) * fix(custom-targets): remove restriction on k8s jfr-jmx/9091, explain localhost:0 (#188) * fix(custom-targets): remove restriction on k8s jfr-jmx/9091, explain localhost:0 * provide more reasons connection test may fail * formatting * docs(guides): update doc for automated rule creation (#193) * expression is CEL * target includes jvmId * spacing * formatting * capitalization * link other guides * correct quotation marks * correct regex syntax * correct examples for labels/annotations maps and optional keys * correct example expr * feat(blog): add post for 3.0.0 release (#177) --------- Co-authored-by: Atif Ali <atali@redhat.com>
Related to #176
Copies the current
latest
into the versioned2.4.0
guide section and updateslatest
andversions
to reference Cryostat 3.0. No actual content update is done yet.$ bundle exec jekyll serve --watch --livereload --open-url --future --config _config.yml,_config-dev.yml
should bring up a local preview of the website. The Get Started guide should reference the 3.0 release and Agent version 0.4.0. The Guides section should default to "3.0.0 - Latest" and the image URLs should be like
images/3.0.0/something.png
. There should be a 2.4.0 selectable in the version dropdown which should have identical content (other than image URL paths) to the 3.0.0 version, and both the 2.4.0/3.0.0 in the preview should be identical to what is currently published on the actual live https://cryostat.io website.