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

docs(screenshots): update screenshots for 2.3.0 #105

Merged
merged 9 commits into from
Apr 27, 2023
Merged

docs(screenshots): update screenshots for 2.3.0 #105

merged 9 commits into from
Apr 27, 2023

Conversation

andrewazores
Copy link
Member

Related to #102

@andrewazores andrewazores added feat New feature or request docs Improvements or additions to documentation labels Apr 27, 2023
@andrewazores andrewazores mentioned this pull request Apr 27, 2023
Merged
3 tasks
@andrewazores andrewazores requested review from tthvo and maxcao13 April 27, 2023 18:56
maxcao13
maxcao13 reviewed Apr 27, 2023
View reviewed changes
Copy link
Member

@maxcao13 maxcao13 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

image

Seems a little strange to have these two text descriptions as different fonts.

It's because some text are inserted as text like

{% include howto_step.html
  summary="Navigate to Settings"
  image-name="2.3.0/navigate-to-settings.png"
  caption="
    Click the cog or gear icon in the application masthead to access the Settings view.
  "
  text=navigate-to-settings-include-text
%}

and some are inserted as html <p> elements like

{% capture navigate-to-settings-include-text %}
<p>
  The Settings view contains web-client instance configuration settings. These
  affect the appearance or behaviour of the web-client frontend only, not the
  behaviour of the Cryostat backend server. These frontend settings are persisted
  to web browser local storage only.
</p>
{% endcapture %}

Maybe any text should be enclosed in <p> except listed elements? I think we should be more careful about which sections should be styled and which should not.

maxcao13
maxcao13 approved these changes Apr 27, 2023
View reviewed changes
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!

tthvo
tthvo approved these changes Apr 27, 2023
View reviewed changes
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 goood!!

@andrewazores andrewazores merged commit c6f513d into version-230 Apr 27, 2023
@andrewazores andrewazores deleted the update-screenshots branch April 27, 2023 20:17
andrewazores added a commit that referenced this pull request Apr 28, 2023
@andrewazores
docs(screenshots): update screenshots for 2.3.0 (#105)
bf61714 
* update screenshots, fix some anchors

* correct filenames

* remove unnecessary paragraph tags

* pluralize

* clarify

* simplify

* singularize

* fixup! singularize

* fixup! fixup! singularize
andrewazores added a commit that referenced this pull request May 5, 2023
@andrewazores
docs(screenshots): update screenshots for 2.3.0 (#105)
307fe17 
* update screenshots, fix some anchors

* correct filenames

* remove unnecessary paragraph tags

* pluralize

* clarify

* simplify

* singularize

* fixup! singularize

* fixup! fixup! singularize
andrewazores added a commit to andrewazores/cryostatio.github.io that referenced this pull request May 24, 2023
@andrewazores
docs(screenshots): update screenshots for 2.3.0 (cryostatio#105)
317b38f 
* update screenshots, fix some anchors

* correct filenames

* remove unnecessary paragraph tags

* pluralize

* clarify

* simplify

* singularize

* fixup! singularize

* fixup! fixup! singularize
andrewazores added a commit that referenced this pull request May 25, 2023
@andrewazores @EstherChristopher @maxcao13
feat(version): copy guides to 2.2.0 version and create new latest/2.3…
85be994 
….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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxcao13 maxcao13 maxcao13 approved these changes

@tthvo tthvo tthvo approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to documentation feat New feature or request
Projects
No open projects
2.3.0 release
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@andrewazores @tthvo @maxcao13