-
Notifications
You must be signed in to change notification settings - Fork 169
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
fix: architecture overview xref statements #2182
fix: architecture overview xref statements #2182
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.
@themr0c, two observations out of scope of this PR:
-
In the sentence "Two workspace engines are available." it would be nice to mention their names. For example: "Two workspace engines are available:
Che server
(default) andDevWorkspace Operator
(technology preview)." -
I find the in-page links
Che architecture with Che Server
andChe architecture with DevWorkspace
confusing, because I can't figure out whether those links are section headings (relevant content, a sentence and a diagram, indeed follows them) or navigation links to other sections (when I click such link, I'm taken to another section). It doesn't look like using a section heading as a link to still another section is a good idea. I mean these:
What does this pull request change?
fix: architecture overview xref statements
What issues does this pull request fix or reference?
broken xref statements
Specify the version of the product this pull request applies to
7.38, 7.39, 7.40
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modified
step reports no vale warnings.