fix: updating end user page navigation (rhdevdocs-5564) (#2641)

eclipse-che · Oct 10, 2023 · a534a2b · a534a2b
1 parent 0249a99
commit a534a2b
Show file tree

Hide file tree

Showing 25 changed files with 66 additions and 160 deletions.
diff --git a/...b-action-yaml-example-activity-types.adoc → ...b-action-yaml-example-activity-types.adoc b/...b-action-yaml-example-activity-types.adoc → ...b-action-yaml-example-activity-types.adoc
diff --git a/...ples/snip_github-action-yaml-example.adoc → ...ples/snip_github-action-yaml-example.adoc b/...ples/snip_github-action-yaml-example.adoc → ...ples/snip_github-action-yaml-example.adoc
diff --git a/...ages/hosted-che/github-action-comment.png → ...er-guide/images/github-action-comment.png b/...ages/hosted-che/github-action-comment.png → ...er-guide/images/github-action-comment.png
diff --git a/...hosted-che/github-action-status-check.png → ...ide/images/github-action-status-check.png b/...hosted-che/github-action-status-check.png → ...ide/images/github-action-status-check.png
diff --git a/modules/end-user-guide/nav.adoc b/modules/end-user-guide/nav.adoc
@@ -1,29 +1,28 @@
 .User Guide
 
-* xref:adopting-che.adoc[]
-** xref:developer-workspaces.adoc[]
-** xref:stack-samples.adoc[]
-** xref:first-time-contributors.adoc[]
-** xref:benefits-of-pull-requests-review-in-che.adoc[]
-* xref:user-onboarding.adoc[]
-** xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[]
-** xref:starting-a-new-workspace-from-a-devfile-url.adoc[]
-** xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
-*** xref:url-parameter-concatenation.adoc[]
-*** xref:url-parameter-for-the-ide.adoc[]
-*** xref:url-parameter-for-starting-duplicate-workspaces.adoc[]
-*** xref:url-parameter-for-the-devfile-file-name.adoc[]
-*** xref:url-parameter-for-the-devfile-file-path.adoc[]
-*** xref:url-parameter-for-the-workspace-storage.adoc[]
-*** xref:url-parameter-for-additional-remotes.adoc[]
-*** xref:url-parameter-for-container-image.adoc[]
+* xref:getting-started-with-che.adoc[]
+** xref:starting-a-workspace-from-a-git-repository-url.adoc[]
+*** xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
+**** xref:url-parameter-concatenation.adoc[]
+**** xref:url-parameter-for-the-ide.adoc[]
+**** xref:url-parameter-for-starting-duplicate-workspaces.adoc[]
+**** xref:url-parameter-for-the-devfile-file-name.adoc[]
+**** xref:url-parameter-for-the-devfile-file-path.adoc[]
+**** xref:url-parameter-for-the-workspace-storage.adoc[]
+**** xref:url-parameter-for-additional-remotes.adoc[]
+**** xref:url-parameter-for-container-image.adoc[]
+** xref:starting-a-workspace-from-a-raw-devfile-url.adoc[]
 ** xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
 ** xref:authenticating-to-a-git-server-from-a-workspace.adoc[]
+* xref:using-che-in-team-workflow.adoc[]
+** xref:first-time-contributors.adoc[]
+** xref:benefits-of-pull-requests-review-in-che.adoc[]
+** xref:try-in-web-ide-github-action.adoc[]
 * xref:customizing-workspace-components.adoc[]
 * xref:devfile-introduction.adoc[]
 * xref:ides-in-workspaces.adoc[]
-** xref:defining-a-common-ide.adoc[]
 ** xref:microsoft-visual-studio-code-open-source-ide.adoc[]
+** xref:defining-a-common-ide.adoc[]
 * xref:using-credentials-and-configurations-in-workspaces.adoc[]
 ** xref:mounting-secrets.adoc[]
 *** xref:creating-image-pull-secrets.adoc[]

diff --git a/modules/end-user-guide/pages/adopting-che.adoc b/modules/end-user-guide/pages/adopting-che.adoc
diff --git a/modules/end-user-guide/pages/customizing-workspace-components.adoc b/modules/end-user-guide/pages/customizing-workspace-components.adoc
@@ -10,7 +10,7 @@
 
 To customize workspace components:
 
-* xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[Choose a Git repository for your workspace].
+* xref:starting-a-workspace-from-a-git-repository-url.adoc[Choose a Git repository for your workspace].
 
 * xref:devfile-introduction.adoc[Use a devfile].
 

diff --git a/modules/end-user-guide/pages/developer-workspaces.adoc b/modules/end-user-guide/pages/developer-workspaces.adoc
diff --git a/modules/end-user-guide/pages/getting-started-with-che.adoc b/modules/end-user-guide/pages/getting-started-with-che.adoc
@@ -0,0 +1,16 @@
+:_content-type: CONCEPT
+:description: Getting started with {prod-short}
+:keywords: getting-started, user-onboarding, new-user, new-users
+:navtitle: Getting started with {prod-short}
+//:page-aliases:user-onboarding
+
+[id="getting-started-with-che"]
+= Getting started with {prod-short}
+
+If your organization is already running a {prod-short} instance, you can get started as a new user by learning how to start a new workspace, manage your workspaces, and authenticate yourself to a Git server from a workspace:
+
+* xref:starting-a-workspace-from-a-git-repository-url.adoc[]
+* xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
+* xref:starting-a-workspace-from-a-raw-devfile-url.adoc[]
+* xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
+* xref:authenticating-to-a-git-server-from-a-workspace.adoc[]
diff --git a/modules/end-user-guide/pages/mounting-git-configuration.adoc b/modules/end-user-guide/pages/mounting-git-configuration.adoc
@@ -48,7 +48,7 @@ EOF
 
 .Verification
 
-. xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[Start a new workspace by using the URL of a remote Git repository] that the Git provider hosts.
+. xref:starting-a-workspace-from-a-git-repository-url.adoc[Start a new workspace by using the URL of a remote Git repository] that the Git provider hosts.
 . Once the workspace is started, open a new terminal in the `tools` container and run `git config --get-regexp user.*`. Your Git user name and email should appear in the output.
 
 
diff --git a/modules/end-user-guide/pages/stack-samples.adoc b/modules/end-user-guide/pages/stack-samples.adoc
diff --git a/...ace-with-a-clone-of-a-git-repository.adoc → ...-workspace-from-a-git-repository-url.adoc b/...ace-with-a-clone-of-a-git-repository.adoc → ...-workspace-from-a-git-repository-url.adoc
@@ -1,11 +1,11 @@
 :_content-type: PROCEDURE
-:description: Starting a new workspace with a clone of a Git repository
+:description: Starting a workspace from a Git repository URL
 :keywords: start-new-workspace, start-a-new-workspace, how-to-start-new-workspace, how-to-start-a-new-workspace, starting-a-new-workspace, clone-git-repository, clone-a-git-repository, how-to-start-workspace, how-to-start-a-workspace
-:navtitle: Starting a new workspace with a clone of a Git repository
+:navtitle: Starting a workspace from a Git repository URL
 :page-aliases:
 
-[id="starting-a-new-workspace-with-a-clone-of-a-git-repository"]
-= Starting a new workspace with a clone of a Git repository
+[id="starting-a-workspace-from-a-git-repository-url"]
+= Starting a workspace from a Git repository URL
 
 With {prod-short}, you can use a URL in your browser to start
 a new workspace that contains a clone of a Git repository.

diff --git a/...g-a-new-workspace-from-a-devfile-url.adoc → ...g-a-workspace-from-a-raw-devfile-url.adoc b/...g-a-new-workspace-from-a-devfile-url.adoc → ...g-a-workspace-from-a-raw-devfile-url.adoc
@@ -1,11 +1,11 @@
 :_content-type: PROCEDURE
-:description: Starting a new workspace from a devfile URL
+:description: Starting a workspace from a raw devfile URL
 :keywords: start-new-workspace, start-a-new-workspace, how-to-start-new-workspace, how-to-start-a-new-workspace, starting-a-new-workspace, how-to-start-workspace, how-to-start-a-workspace
-:navtitle: Starting a new workspace from a devfile URL
+:navtitle: Starting a workspace from a raw devfile URL
 :page-aliases:
 
-[id="starting-a-new-workspace-from-a-devfile-url"]
-= Starting a new workspace from a devfile URL
+[id="starting-a-workspace-from-a-raw-devfile-url"]
+= Starting a workspace from a raw devfile URL
 
 With {prod-short}, you can open a *devfile* URL in your browser to start a new workspace.
 

diff --git a/...e/pages/try-in-web-ide-github-action.adoc → ...e/pages/try-in-web-ide-github-action.adoc b/...e/pages/try-in-web-ide-github-action.adoc → ...e/pages/try-in-web-ide-github-action.adoc
@@ -2,6 +2,6 @@
 // = Try in Web IDE GitHub action
 :navtitle: Try in Web IDE GitHub action
 :keywords: hosted-che, try-in-web-ide-github-action
-:page-aliases: .:try-in-web-ide-github-action
+:page-aliases:
 
-include::partial$assembly_try-in-web-ide-github-action.adoc[]
+include::partial$assembly_try-in-web-ide-github-action.adoc[offset=1]
diff --git a/modules/end-user-guide/pages/user-onboarding.adoc b/modules/end-user-guide/pages/user-onboarding.adoc
diff --git a/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc b/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc
@@ -134,7 +134,7 @@ EOF
 
 .Verification
 
-. xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[Start a new workspace by using the URL of a remote Git repository] that the Git provider hosts.
+. xref:starting-a-workspace-from-a-git-repository-url.adoc[Start a new workspace by using the URL of a remote Git repository] that the Git provider hosts.
 . Make some changes and push to the remote Git repository from the workspace.
 
 .Additional resources

diff --git a/modules/end-user-guide/pages/using-che-in-team-workflow.adoc b/modules/end-user-guide/pages/using-che-in-team-workflow.adoc
@@ -0,0 +1,14 @@
+:_content-type: CONCEPT
+:description: Using {prod-short} in team workflow
+:keywords: adopt, adopting, adoption
+:navtitle: Using {prod-short} in team workflow
+//:page-aliases:adopting-che
+
+[id="using-che-in-team-workflow"]
+= Using {prod-short} in team workflow
+
+Learn about the benefits of using {prod-short} in your organization in the following articles:
+
+* xref:first-time-contributors.adoc[]
+* xref:benefits-of-pull-requests-review-in-che.adoc[]
+
diff --git a/...ssembly_try-in-web-ide-github-action.adoc → ...ssembly_try-in-web-ide-github-action.adoc b/...ssembly_try-in-web-ide-github-action.adoc → ...ssembly_try-in-web-ide-github-action.adoc
diff --git a/...tion-to-a-github-repository-workflow.adoc → ...tion-to-a-github-repository-workflow.adoc b/...tion-to-a-github-repository-workflow.adoc → ...tion-to-a-github-repository-workflow.adoc
diff --git a/...stallation-of-microsoft-visual-studio-code-extensions-at-workspace-startup.adoc b/...stallation-of-microsoft-visual-studio-code-extensions-at-workspace-startup.adoc
@@ -48,7 +48,7 @@ https://www.open-vsx.org/extension/__<publisher>__/__<extension>__
 
 .Verification
 
-. xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[Start a new workspace by using the URL of the remote Git repository] that contains the created `extensions.json` file.
+. xref:starting-a-workspace-from-a-git-repository-url.adoc[Start a new workspace by using the URL of the remote Git repository] that contains the created `extensions.json` file.
 . In the IDE of the workspace, press kbd:[Ctrl+Shift+X] or go to *Extensions* to find each of the extensions listed in the file.
 . The extension has the label *This extension is enabled globally*.
 

diff --git a/...he/partials/proc_providing-a-devfile.adoc → ...de/partials/proc_providing-a-devfile.adoc b/...he/partials/proc_providing-a-devfile.adoc → ...de/partials/proc_providing-a-devfile.adoc
diff --git a/modules/end-user-guide/partials/proc_setting-up-che-editor-yaml.adoc b/modules/end-user-guide/partials/proc_setting-up-che-editor-yaml.adoc
@@ -9,6 +9,6 @@ By using the `che-editor.yaml` file, you can set a common default IDE for your t
 
 .Verification
 
-. xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[Start a new workspace with a clone of the Git repository].
+. xref:starting-a-workspace-from-a-git-repository-url.adoc[Start a new workspace with a clone of the Git repository].
 . Verify that the specified IDE loads in the browser tab of the started workspace.
 
diff --git a/...f_about-try-in-web-ide-github-action.adoc → ...f_about-try-in-web-ide-github-action.adoc b/...f_about-try-in-web-ide-github-action.adoc → ...f_about-try-in-web-ide-github-action.adoc
@@ -12,7 +12,7 @@ This factory URL creates a new workspace from the pull request branch on Eclipse
 NOTE: The Che documentation repository (https://github.com/eclipse/che-docs) is a real-life example where the Try in Web IDE GitHub action helps reviewers quickly test pull requests. Experience the workflow by navigating to a recent pull request and opening a factory URL.
 
 .Pull request comment created by the Try in Web IDE GitHub action. Clicking the badge opens a new workspace for reviewers to test the pull request.
-image::hosted-che/github-action-comment.png[test]
+image::github-action-comment.png[test]
 
 .Pull request status check created by the Try in Web IDE GitHub action. Clicking the "Details" link opens a new workspace for reviewers to test the pull request.
-image::hosted-che/github-action-status-check.png[test]
+image::github-action-status-check.png[test]
diff --git a/modules/hosted-che/nav.adoc b/modules/hosted-che/nav.adoc
@@ -1,2 +1 @@
-* xref:hosted-che.adoc[]
-** xref:try-in-web-ide-github-action.adoc[]
+* xref:hosted-che.adoc[]
diff --git a/modules/hosted-che/partials/assembly_hosted-che.adoc b/modules/hosted-che/partials/assembly_hosted-che.adoc
@@ -21,5 +21,5 @@ include::partial$ref_hosted-che-faq-and-troubleshooting.adoc[leveloffset=+1]
 
 .Additional resources
 
-* For general end-user guidance, see xref:end-user-guide:user-onboarding.adoc[].
+* For general end-user guidance, see xref:end-user-guide:getting-started-with-che.adoc[].
Original file line number	Diff line number	Diff line change
Expand Up		@@ -21,5 +21,5 @@ include::partial$ref_hosted-che-faq-and-troubleshooting.adoc[leveloffset=+1]

		.Additional resources

		* For general end-user guidance, see xref:end-user-guide:user-onboarding.adoc[].
		* For general end-user guidance, see xref:end-user-guide:getting-started-with-che.adoc[].