procedures: starting a new workspace #2227
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changes to be committed: modified: .github/workflows/build-and-validate-on-pr.yaml new file: .github/workflows/build-container.yml modified: .github/workflows/publish-netlify.yml modified: .gitignore modified: Dockerfile modified: antora-playbook-for-development.yml modified: gulpfile.js modified: modules/user-guide/nav.adoc modified: modules/user-guide/pages/projects-with-git.adoc deleted: package.json deleted: supplemental-ui/.htaccess new file: supplemental-ui/css/search.css new file: supplemental-ui/js/search-ui.js modified: supplemental-ui/partials/footer-content.hbs modified: supplemental-ui/partials/head-meta.hbs modified: supplemental-ui/partials/header-content.hbs modified: tools/get_vale_styles.sh
13 tasks
themr0c
reviewed
Mar 23, 2022
modules/user-guide/pages/parameters-for-the-urls-for-starting-a-new-workspace.adoc
Outdated
Show resolved
Hide resolved
themr0c
reviewed
Mar 23, 2022
modules/user-guide/pages/parameters-for-the-urls-for-starting-a-new-workspace.adoc
Outdated
Show resolved
Hide resolved
max-cx
changed the title
max-cx
changed the title
modules/user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
Show resolved
Hide resolved
modules/user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
Show resolved
Hide resolved
modules/user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
Show resolved
Hide resolved
modules/user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
Show resolved
Hide resolved
| * Your organization has a running instance of {prod-short}. | ||
| * You have been given the xref:url-of-your-organizations-che-instance.adoc[]. | ||
| * Your Git repository maintainer keeps the `devfile.yaml` or `.devfile.yaml` file in the root directory of the Git repository. | ||
| * Optional: Private repositories that are hosted on GitHub, GitLab, or Bitbucket require (1) an authorized application link to be created on the repository-hosting website by the repository maintainer (which is you for your fork) and (2) a {platforms-name} secret to be applied by the administrator of the {prod-short} instance that belongs to your organization. |
There was a problem hiding this comment.
Suggested change
| * Optional: Private repositories that are hosted on GitHub, GitLab, or Bitbucket require (1) an authorized application link to be created on the repository-hosting website by the repository maintainer (which is you for your fork) and (2) a {platforms-name} secret to be applied by the administrator of the {prod-short} instance that belongs to your organization. | |
| * Optional: Private repositories that are hosted on GitHub, GitLab, or Bitbucket require: | |
| - An authorized application link to be created on the repository-hosting website by the repository maintainer (which is you for your fork) and | |
| - A {platforms-name} secret to be applied by the administrator of the {prod-short} instance that belongs to your organization. | |
|
|
||
| .Procedure | ||
|
|
||
| . Optional: visit the xref:url-of-your-che-dashboard.adoc[] to log in as a {prod-short} user to your organization's instance of {prod-short}. |
There was a problem hiding this comment.
Suggested change
| . Optional: visit the xref:url-of-your-che-dashboard.adoc[] to log in as a {prod-short} user to your organization's instance of {prod-short}. | |
| . Optional: Visit the xref:url-of-your-che-dashboard.adoc[] to log in as a {prod-short} user to your organization's instance of {prod-short}. |
| [id="url-of-your-{prod-id-short}-dashboard_{context}"] | ||
| = URL of your {prod-short} dashboard | ||
|
|
||
| The *Workspaces* page of your {prod-short} dashboard is where you manage your workspaces and verify their current states. The URL syntax for this page is like so: |
There was a problem hiding this comment.
Suggested change
| The *Workspaces* page of your {prod-short} dashboard is where you manage your workspaces and verify their current states. The URL syntax for this page is like so: | |
| The *Workspaces* page of your {prod-short} dashboard is where you manage your workspaces and verify their current states. The URL syntax for this page is as follows: |
| {prod-url}#__<git_repository_url>__?new | ||
| ---- | ||
|
|
||
| NOTE: Attempting to reuse the devfile and linked Git repository without the `new` URL parameter to start a new workspace in addition to a workspace that already exists results in an error message. |
There was a problem hiding this comment.
Suggested change
| NOTE: Attempting to reuse the devfile and linked Git repository without the `new` URL parameter to start a new workspace in addition to a workspace that already exists results in an error message. | |
| NOTE: Attempting to reuse the devfile and linked Git repository without the `new` URL parameter to start a new workspace in addition to a workspace that already exists will provide an error message. |
| [id="url-parameter-for-the-devfile-file-name_{context}"] | ||
| = URL parameter for the devfile file name | ||
|
|
||
| When you visit a URL for starting a new workspace, {prod-short} searches the linked Git repository for a devfile with the file name `.devfile.yaml` or `devfile.yaml`. So the devfile in the linked Git repository must follow this convention. |
There was a problem hiding this comment.
Suggested change
| When you visit a URL for starting a new workspace, {prod-short} searches the linked Git repository for a devfile with the file name `.devfile.yaml` or `devfile.yaml`. So the devfile in the linked Git repository must follow this convention. | |
| When you visit a URL for starting a new workspace, {prod-short} searches the linked Git repository for a devfile with the file name `.devfile.yaml` or `devfile.yaml`. Therefore, the devfile in the linked Git repository must follow the convention. |
| [id="url-parameter-for-the-devfile-file-path_{context}"] | ||
| = URL parameter for the devfile file path | ||
|
|
||
| When you visit a URL for starting a new workspace, {prod-short} searches the root directory of the linked Git repository for a devfile (with the file name `.devfile.yaml` or `devfile.yaml`). So the file path of the devfile in the linked Git repository must follow this convention. |
There was a problem hiding this comment.
Suggested change
| When you visit a URL for starting a new workspace, {prod-short} searches the root directory of the linked Git repository for a devfile (with the file name `.devfile.yaml` or `devfile.yaml`). So the file path of the devfile in the linked Git repository must follow this convention. | |
| When you visit a URL for starting a new workspace, {prod-short} searches the root directory of the linked Git repository for a devfile (with the file name `.devfile.yaml` or `devfile.yaml`). Therefore, the file path of the devfile in the linked Git repository must follow the convention. |
| [id="url-parameter-for-the-workspace-ide_{context}"] | ||
| = URL parameter for the workspace IDE | ||
|
|
||
| Che-Theia is currently the default integrated development environment (IDE) that a workspace loads with if no IDE is specified as a URL parameter as part of the URL for starting a new workspace. |
There was a problem hiding this comment.
Suggested change
| Che-Theia is currently the default integrated development environment (IDE) that a workspace loads with if no IDE is specified as a URL parameter as part of the URL for starting a new workspace. | |
| Che-Theia is currently the default integrated development environment (IDE) loaded by a workspace if no IDE is specified as a URL parameter as part of the URL for starting a new workspace. |
|
Migrating the contents of this PR into a new PR for the master branch. |
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this pull request change
Adding the first batch of new content to the new docs.
What issues does this pull request fix or reference
RHDEVDOCS-3505 > RHDEVDOCS-3789, RHDEVDOCS-3790
Specify the version of the product this pull request applies to
7.42+
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 modifiedstep reports no vale warnings.