Skip to content

[DOCS-4552] Flat hirerachy to increase readability#3023

Open
gtrivedi88 wants to merge 1 commit intoeclipse-che:mainfrom
gtrivedi88:DOCS-4552
Open

[DOCS-4552] Flat hirerachy to increase readability#3023
gtrivedi88 wants to merge 1 commit intoeclipse-che:mainfrom
gtrivedi88:DOCS-4552

Conversation

@gtrivedi88
Copy link
Contributor

@gtrivedi88 gtrivedi88 commented Feb 3, 2026

What does this pull request change?

  • Split the single nested procedure into two separate, flat procedures:
    • proc_adding-extensions-using-devspaces-workspace.adoc - For building within a Dev Spaces workspace
    • proc_adding-extensions-using-linux.adoc - For building on a Linux system
  • Eliminated 4-level nesting (., .., ..., ....) in favor of flat, numbered steps
  • Each procedure is now a standalone module with its own prerequisites, procedure steps, and verification
  • Updated cross-references in proc_selecting-an-open-vsx-registry-instance.adoc and snip_che-non-default-vsx-registry-instance.adoc
  • Deleted obsolete files:
    • proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc
    • snip_che-steps-to-build-custom-plugin-registry-in-workspace.adoc
    • snip_che-steps-to-add-or-remove-extensions-in-openvsx-sync-json.adoc

Benefits:

  • Significantly improved readability (addresses user feedback about content being "unreadable")
  • Follows Red Hat modular documentation guidelines (no subheadings in procedure modules)
  • Users can navigate directly to the method relevant to their environment
  • Reduced cognitive load with clear, linear procedures

What issues does this pull request fix or reference?

Fixes: [issue number if available, or describe the feedback]

  • User feedback: "The whole section is unreadable, all stuff is mixed up"

Specify the version of the product this pull request applies to

main, 3.26, 3.25

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 both procedures (Dev Spaces and Linux methods)
  • Any page or link rename:
    • Cross-references updated (no URL redirections needed - anchor IDs maintained)
    • Propagate the URL change in:
      • N/A - No changes to Dashboard branding data required
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@github-actions
Copy link

github-actions bot commented Feb 3, 2026

🎊 Navigate the preview: https://69821a40bc306725444efab5--eclipse-che-docs-pr.netlify.app 🎊

@github-actions
Copy link

github-actions bot commented Feb 3, 2026

Click here to review and test in web IDE: Contribute

@gtrivedi88 gtrivedi88 force-pushed the DOCS-4552 branch 2 times, most recently from 4c67ffb to d02127e Compare February 3, 2026 14:18
@ibuziuk ibuziuk requested a review from svor February 3, 2026 14:24
@gtrivedi88 gtrivedi88 changed the title [DOCS-4552] Flat hirerachy to increase readeability [DOCS-4552] Flat hirerachy to increase readability Feb 3, 2026
@gtrivedi88 gtrivedi88 force-pushed the DOCS-4552 branch 2 times, most recently from 711fbc4 to db57667 Compare February 3, 2026 15:30

[IMPORTANT]
====
The embedded plugin registry will be deprecated in future releases and replaced by the Open VSX registry. Setting up an internal, on-premises Open VSX registry provides full control over the extension lifecycle, enables offline use, and improves compliance. Refer to the xref:running-the-open-vsx-on-premises.adoc[Running the Open VSX On-Premises] procedure for detailed setup instructions.
Copy link
Contributor

Choose a reason for hiding this comment

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

It's already deprecated. See this PR: #3019

.Procedure

* Edit the `openVSXURL` value in the `CheCluster` custom resource:
. Log on to the cluster as an administrator.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we use Log in as we do that in other places?

@@ -1,14 +0,0 @@
... Start a workspace using the link:https://github.com/eclipse-che/che-plugin-registry[plugin registry repository].
Copy link
Contributor

Choose a reason for hiding this comment

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

@@ -1,3 +0,0 @@
... Download or fork and clone the link:https://github.com/eclipse-che/che-plugin-registry[plugin registry repository].
Copy link
Contributor

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants