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

fix: architecture overview xref statements #2182

Merged
merged 7 commits into from
Dec 10, 2021
Merged

fix: architecture overview xref statements #2182

merged 7 commits into from
Dec 10, 2021

Conversation

themr0c
Copy link
Contributor

@themr0c themr0c commented Dec 7, 2021

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.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@themr0c themr0c requested review from rkratky and a team as code owners December 7, 2021 08:14
@themr0c themr0c requested a review from amisevsk December 7, 2021 08:14
@themr0c themr0c added this to the 7.38 milestone Dec 7, 2021
@themr0c themr0c self-assigned this Dec 7, 2021
@github-actions
Copy link

github-actions bot commented Dec 7, 2021

Click here to review and test in web IDE: Contribute

Copy link
Contributor

@max-cx max-cx left a 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:

  1. 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) and DevWorkspace Operator (technology preview)."

  2. I find the in-page links Che architecture with Che Server and Che 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:
    image

@themr0c themr0c merged commit 0b802f5 into eclipse-che:master Dec 10, 2021
@themr0c themr0c deleted the fix-architecture-overview-xrefs branch December 10, 2021 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants