-
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
Create document-agent's-general-description+purpose.md #101
Create document-agent's-general-description+purpose.md #101
Conversation
Documented the Agent's general description + purpose Signed-off-by: Esther Christopher <estheradamuchris@gmail.com>
get-started/document-agent's-general-description+purpose.md
Outdated
Show resolved
Hide resolved
get-started/document-agent's-general-description+purpose.md
Outdated
Show resolved
Hide resolved
get-started/document-agent's-general-description+purpose.md
Outdated
Show resolved
Hide resolved
get-started/document-agent's-general-description+purpose.md
Outdated
Show resolved
Hide resolved
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.
Hi @EstherChristopher , thanks again for volunteering to write this up. This is a great summary! I have a few minor comments, but this generally looks good already.
Effected the corrections. Signed-off-by: Esther Christopher <estheradamuchris@gmail.com>
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.
@EstherChristopher thanks again for your contribution! I just made a few last touch-ups.
You're welcome @andrewazores. I'm glad to have contributed to this project. I can see that it's been merged and that's great. I've been away for a bit because of my school exams but I will get started with the other one as soon as I can. |
* Create document-agent's-general-description+purpose.md Documented the Agent's general description + purpose Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * Update document-agent's-general-description+purpose.md Effected the corrections. Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * minor fixes * move content into guide --------- Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> Co-authored-by: Andrew Azores <aazores@redhat.com>
* Create document-agent's-general-description+purpose.md Documented the Agent's general description + purpose Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * Update document-agent's-general-description+purpose.md Effected the corrections. Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * minor fixes * move content into guide --------- Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> Co-authored-by: Andrew Azores <aazores@redhat.com>
* Create document-agent's-general-description+purpose.md Documented the Agent's general description + purpose Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * Update document-agent's-general-description+purpose.md Effected the corrections. Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * minor fixes * move content into guide --------- Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> Co-authored-by: Andrew Azores <aazores@redhat.com>
….0 version (#103) * feat(version): copy guides to 2.2.0 version and create new latest/2.3.0 version * docs(agent): create initial content for Cryostat Agent (#101) * Create document-agent's-general-description+purpose.md Documented the Agent's general description + purpose Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * Update document-agent's-general-description+purpose.md Effected the corrections. Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> * minor fixes * move content into guide --------- Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> Co-authored-by: Andrew Azores <aazores@redhat.com> * docs(screenshots): update screenshots for 2.3.0 (#105) * update screenshots, fix some anchors * correct filenames * remove unnecessary paragraph tags * pluralize * clarify * simplify * singularize * fixup! singularize * fixup! fixup! singularize * chore(versions): bump supported platform versions (#111) * feat(demo): embed web-client with fake API stubs as a demo (#109) * docs(getting-started): update sample app example (#115) * docs(auth): remove outdated Bearer form, add details on OpenShift and Basic mechanisms (#113) * doc(auth): remove outdated Bearer form, add details on OpenShift and Basic mechanisms Signed-off-by: Andrew Azores <aazores@redhat.com> * reflow * formatting * backtick quotes --------- Signed-off-by: Andrew Azores <aazores@redhat.com> * feat(cred): document credentials testing table (#119) * docs(get-started): add information about the Agent and JMX config (#104) * 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 * feat(topology): document topology view and custom target form (#118) * 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 <thvo@redhat.com> --------- Signed-off-by: Thuan Vo <thvo@redhat.com> * chore(docs): update (un)installation info, images, and document ClusterCryostat (#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 * docs(dashboard): document dashboard and dashboard cards (#121) * init commit Signed-off-by: Max Cao <macao@redhat.com> * add mbean metrics, layouts/templates Signed-off-by: Max Cao <macao@redhat.com> * fix widescreen -> fullscreen Signed-off-by: Max Cao <macao@redhat.com> --------- Signed-off-by: Max Cao <macao@redhat.com> * feat(blog): add 2.3.0 release post (#124) * 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 --------- Signed-off-by: Esther Christopher <estheradamuchris@gmail.com> Signed-off-by: Andrew Azores <aazores@redhat.com> Signed-off-by: Thuan Vo <thvo@redhat.com> Signed-off-by: Max Cao <macao@redhat.com> Co-authored-by: Esther Christopher <estheradamuchris@gmail.com> Co-authored-by: Thuan Vo <thvo@redhat.com> Co-authored-by: Max Cao <macao@redhat.com>
Documented the Agent's general description + purpose
Related to #95