docs: Rewriting pages about editors #2552

max-cx · 2023-02-13T17:44:08Z

What does this pull request change?

This PR improves the docs pages about editors.

What issues does this pull request fix or reference?

https://issues.redhat.com/browse/RHDEVDOCS-4789

Specify the version of the product this pull request applies to

Merge to main.
Cherry-pick to 7.60.x, 7.61.x, 7.62.x.

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:
- The page contains a redirection for the previous URL.
- Propagate the URL change in:
  - Dashboard default branding data
  - Chectl constants.ts
Builds on Eclipse Che hosted by Red Hat.
the Validate language on files added or modified step reports no vale warnings.

github-actions · 2023-02-13T17:44:19Z

🎊 Navigate the preview: https://641aaf1f951bef5e4337877c--eclipse-che-docs-pr.netlify.app 🎊

github-actions · 2023-02-13T17:44:20Z

Click here to review and test in web IDE:

github-actions · 2023-02-13T17:44:21Z

Click here to review and test in web IDE:

modules/end-user-guide/partials/ref_parameters-for-che-editor-yaml.adoc

… instance'

modules/end-user-guide/pages/cloud-ides-in-workspaces.adoc

modules/end-user-guide/pages/url-parameter-for-the-cloud-ide.adoc

modules/end-user-guide/pages/defining-a-common-ide.adoc

modules/end-user-guide/pages/microsoft-visual-studio-code-open-source-ide.adoc

Co-authored-by: Mario Loriedo <[email protected]>

modules/end-user-guide/pages/microsoft-visual-studio-code-open-source-ide.adoc

l0rd · 2023-03-14T08:58:24Z

modules/end-user-guide/partials/proc_adding-vs-code-extensions.adoc

@@ -0,0 +1,58 @@
+
+[id="adding-vs-code-extensions"]
+= Adding `VS Code` extensions


Suggested change

= Adding `VS Code` extensions

= Automating VS Code extensions installation at worksapce startup

Adding an extension is about manually installing a VS Code extensions via the extensions view. But this section is about something else: it's about configuring your repository so that the extensions get installed automatically.

If we leave it like that, a user may think that the only way to add an extensions is adding a .vscode/extensions.json in the git repository (something he may not do if he is not a maintainer of the repo).

Wonderful! Thank you. I'm applying this suggestion, just with a slight rewording:
= Automating installation of Microsoft Visual Studio Code extensions at workspace startup
(Unfortunately, the IDE name has to be longer.)

…-source-ide.adoc Co-authored-by: Mario Loriedo <[email protected]>

modules/end-user-guide/partials/proc_adding-vs-code-extensions.adoc

….adoc

* initial changes * fix: rewriting the IDE-related pages * edit 'Adding or removing extensions in the embedded Open VSX registry instance' * rewrite the assembly and remove the outdated concept module * new edits * further edits * fix: typo * remove the mention of the editorconfig file * Update modules/end-user-guide/pages/url-parameter-for-the-cloud-ide.adoc Co-authored-by: Mario Loriedo <[email protected]> * Update modules/end-user-guide/pages/url-parameter-for-the-cloud-ide.adoc Co-authored-by: Mario Loriedo <[email protected]> * initial changes in response to Mario's feedback * work in progress * remove 'cloud' from IDE * add an admonition requested by Mario * incorporate new feedback from Artem * Restarting the jobs * Add 'Restart Workspace from Local Devfile' command to the corresponding section Co-authored-by: Max Leonov <[email protected]> * rewrite of the vsx-related procedure due to changes in vsx.org * Update modules/end-user-guide/partials/proc_adding-vs-code-extensions.adoc * edit proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc * Apply suggestions from code review * Update modules/end-user-guide/pages/defining-a-common-ide.adoc * Update modules/end-user-guide/pages/url-parameter-for-the-ide.adoc * Update modules/end-user-guide/pages/ides-in-workspaces.adoc Co-authored-by: Jana Vrbkova <[email protected]> * Apply suggestions from code review * minor edit * another minor edit * another minor edit * another minor edit * another minor edit * another minor edit * another minor edit * minor edit * minor edit * minor edit * apply changes requested in #2552 (comment) * manually apply suggestion from code review * minor edit * test rearranging the steps due to the snippet file * rearrange admonition content * minor edit * minor edit * Update modules/end-user-guide/pages/microsoft-visual-studio-code-open-source-ide.adoc Co-authored-by: Mario Loriedo <[email protected]> * Update modules/end-user-guide/partials/proc_adding-vs-code-extensions.adoc * rename section heading and file name * edit the section heading and file name * minor edit * merge two tips * temporary xref fix - correct text, parking file * temporary cross-reference fix --------- Co-authored-by: Mario Loriedo <[email protected]> Co-authored-by: RomanNikitenko <[email protected]> Co-authored-by: Jana Vrbkova <[email protected]>

max-cx added 2 commits February 10, 2023 23:11

initial changes

e567fbb

fix: rewriting the IDE-related pages

93eef14

max-cx requested review from rkratky and a team as code owners February 13, 2023 17:44

max-cx requested a review from nickboldt February 13, 2023 17:44

che-bot added target/branch status/code-review labels Feb 13, 2023

nickboldt reviewed Feb 15, 2023

View reviewed changes

modules/end-user-guide/partials/ref_parameters-for-che-editor-yaml.adoc Outdated Show resolved Hide resolved

max-cx added 4 commits February 15, 2023 15:18

edit 'Adding or removing extensions in the embedded Open VSX registry…

2462606

… instance'

rewrite the assembly and remove the outdated concept module

39b74e3

new edits

f2bcf40

further edits

d862bca

max-cx force-pushed the 4789 branch from d9b82c7 to d862bca Compare February 16, 2023 16:17

fix: typo

8aadf90

l0rd requested changes Feb 16, 2023

View reviewed changes

max-cx and others added 5 commits February 17, 2023 10:18

remove the mention of the editorconfig file

a373437

Update modules/end-user-guide/pages/url-parameter-for-the-cloud-ide.adoc

ba4cc1e

Co-authored-by: Mario Loriedo <[email protected]>

Update modules/end-user-guide/pages/url-parameter-for-the-cloud-ide.adoc

d9ad0d2

Co-authored-by: Mario Loriedo <[email protected]>

initial changes in response to Mario's feedback

7accd9e

work in progress

d0c5266

max-cx requested a review from deerskindoll as a code owner February 22, 2023 17:03

max-cx force-pushed the 4789 branch from e9c8615 to c873b62 Compare March 1, 2023 09:23

remove 'cloud' from IDE

77b50ae

max-cx force-pushed the 4789 branch from c873b62 to 77b50ae Compare March 1, 2023 09:28

add an admonition requested by Mario

0b442cf

rearrange admonition content

74b9d2d

max-cx force-pushed the 4789 branch from 8a20e5c to 74b9d2d Compare March 13, 2023 21:59

l0rd reviewed Mar 14, 2023

View reviewed changes

modules/end-user-guide/pages/microsoft-visual-studio-code-open-source-ide.adoc Outdated Show resolved Hide resolved

minor edit

bedfd05

l0rd reviewed Mar 14, 2023

View reviewed changes

max-cx and others added 2 commits March 14, 2023 11:48

minor edit

4170924

Update modules/end-user-guide/pages/microsoft-visual-studio-code-open…

958b6cf

…-source-ide.adoc Co-authored-by: Mario Loriedo <[email protected]>

max-cx commented Mar 14, 2023

View reviewed changes

modules/end-user-guide/partials/proc_adding-vs-code-extensions.adoc Outdated Show resolved Hide resolved

max-cx added 6 commits March 14, 2023 12:33

Update modules/end-user-guide/partials/proc_adding-vs-code-extensions…

2b54c41

….adoc

rename section heading and file name

47d4edd

edit the section heading and file name

1cdb621

minor edit

1484bd3

merge two tips

31252fe

temporary xref fix - correct text, parking file

3b3bb4f

max-cx force-pushed the 4789 branch from f50518c to 908053c Compare March 14, 2023 15:26

temporary cross-reference fix

d5a6c2c

max-cx force-pushed the 4789 branch from 908053c to d5a6c2c Compare March 14, 2023 15:36

rkratky approved these changes Mar 14, 2023

View reviewed changes

max-cx merged commit 7e669af into eclipse-che:main Mar 14, 2023

che-bot removed the status/code-review label Mar 14, 2023

max-cx added backported to 7.60.x backported to 7.61.x backported to 7.62.x labels Mar 14, 2023

max-cx deleted the 4789 branch March 14, 2023 17:28

che-bot added this to the 7.63 milestone Mar 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Rewriting pages about editors #2552

docs: Rewriting pages about editors #2552

max-cx commented Feb 13, 2023 •

edited

Loading

github-actions bot commented Feb 13, 2023 •

edited

Loading

github-actions bot commented Feb 13, 2023

github-actions bot commented Feb 13, 2023

l0rd Mar 14, 2023 •

edited

Loading

max-cx Mar 14, 2023 •

edited

Loading

		@@ -0,0 +1,58 @@

		[id="adding-vs-code-extensions"]
		= Adding `VS Code` extensions

	= Adding `VS Code` extensions
	= Automating VS Code extensions installation at worksapce startup

docs: Rewriting pages about editors #2552

docs: Rewriting pages about editors #2552

Conversation

max-cx commented Feb 13, 2023 • edited Loading

What does this pull request change?

What issues does this pull request fix or reference?

Specify the version of the product this pull request applies to

Pull Request checklist

github-actions bot commented Feb 13, 2023 • edited Loading

github-actions bot commented Feb 13, 2023

github-actions bot commented Feb 13, 2023

l0rd Mar 14, 2023 • edited Loading

Choose a reason for hiding this comment

max-cx Mar 14, 2023 • edited Loading

Choose a reason for hiding this comment

max-cx commented Feb 13, 2023 •

edited

Loading

github-actions bot commented Feb 13, 2023 •

edited

Loading

l0rd Mar 14, 2023 •

edited

Loading

max-cx Mar 14, 2023 •

edited

Loading