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.

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

feat(version): copy guides to 2.2.0 version and create new latest/2.3.0 version #103

Merged
merged 13 commits into from
May 25, 2023

Conversation

@andrewazores andrewazores added feat New feature or request docs Improvements or additions to documentation labels Apr 26, 2023
@andrewazores andrewazores marked this pull request as ready for review April 26, 2023 17:41
@andrewazores andrewazores force-pushed the version-230 branch 2 times, most recently from bf61714 to 307fe17 Compare May 5, 2023 16:21
andrewazores and others added 12 commits May 24, 2023 14:20
* Create document-agent's-general-description+purpose.md

Documented the Agent's general description + purpose

Signed-off-by: Esther Christopher <[email protected]>

* Update document-agent's-general-description+purpose.md

Effected the corrections. 

Signed-off-by: Esther Christopher <[email protected]>

* minor fixes

* move content into guide

---------

Signed-off-by: Esther Christopher <[email protected]>
Co-authored-by: Andrew Azores <[email protected]>
* update screenshots, fix some anchors

* correct filenames

* remove unnecessary paragraph tags

* pluralize

* clarify

* simplify

* singularize

* fixup! singularize

* fixup! fixup! singularize
… Basic mechanisms (#113)

* doc(auth): remove outdated Bearer form, add details on OpenShift and Basic mechanisms

Signed-off-by: Andrew Azores <[email protected]>

* reflow

* formatting

* backtick quotes

---------

Signed-off-by: Andrew Azores <[email protected]>
* docs(get-started): add information about the Agent and JMX config

* typo

* rephrase

* quotes and typo

* add anchors

* openshift -> kubernetes

* add note about maven registry auth

* add comments

* accept suggestion

* typo

* formatting

* typo

* formatting

* break comment lines

* use yaml multiline

* plural

* rephrase

* add explanation comment

* fixup! add explanation comment

* rebase fix

* list configuration combinations before explaining them

* add links

* rephrase

* fix typo

* fixup! fix typo

* explain agent deployment environment variables more

* explain cross-namespace Agent and Cryostat

* reference agent version 0.2.1

* in hybrid agent setup, skip the jfr-jmx named port

* set explicit hostname for JMX

* reorganize
* chore(rules): update docs to mention Match Expression Visualizer

* feat(topology): add docs for creating a custom target

* feat(topology): document topology usage

Signed-off-by: Thuan Vo <[email protected]>

---------

Signed-off-by: Thuan Vo <[email protected]>
…erCryostat (#117)

* docs(install): update installation information and images

* update operator-sdk version

* add table of contents

* update step reference and links

* add documentation about ClusterCryostat

* split text into list

* use usual default CR YAML for example

* specify example's installation mode

* distinguish OpenShift Console Topology View

* cleanup outdated info

* fixup! cleanup outdated info

* correct screenshot

* explain why CRs are namespace-specific

* commas

* remove outdated alternate operator installation methods

* remove unused uninstallation steps

* inline doc

* point GitHub docs links to release branches, not latest development

* add detail

* comma

* clarify one instance of Kubernetes-specific requirement

* update olm instructions

* syntax highlighting hints
* init commit

Signed-off-by: Max Cao <[email protected]>

* add mbean metrics, layouts/templates

Signed-off-by: Max Cao <[email protected]>

* fix widescreen -> fullscreen

Signed-off-by: Max Cao <[email protected]>

---------

Signed-off-by: Max Cao <[email protected]>
* chore(gem): add table-of-contents plugin

* chore(blog): enable toc plugin on existing blog posts

* feat(blog): add 2.3.0 release announcement post

* link helm to specific release

* add note about OLM

* add link

* comma

* comma

* set blog date
@andrewazores andrewazores requested a review from maxcao13 May 25, 2023 16:13
@andrewazores
Copy link
Member Author

Can I get a final look-over and approval for this PR? All the changes have been individually reviewed.

Copy link
Member

@maxcao13 maxcao13 left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Copy link
Member

@tthvo tthvo left a comment

Choose a reason for hiding this comment

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

Looks great to me too!

@andrewazores andrewazores merged commit 85be994 into main May 25, 2023
@andrewazores andrewazores deleted the version-230 branch May 25, 2023 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation feat New feature or request
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants