diff --git a/.gitignore b/.gitignore index bed5638306..d7a37026fe 100644 --- a/.gitignore +++ b/.gitignore @@ -43,3 +43,4 @@ yarn.lock # Do not commit diagrams generated for downstream crw* +CLAUDE.md diff --git a/antora.yml b/antora.yml index f019768006..ce27a0eebf 100644 --- a/antora.yml +++ b/antora.yml @@ -15,6 +15,7 @@ nav: - modules/secure/nav.adoc - modules/optimize/nav.adoc - modules/observe/nav.adoc + - modules/integrate/nav.adoc - modules/administration-guide/nav.adoc - modules/extensions/nav.adoc - modules/glossary/nav.adoc diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index ad78f8b903..ee820e913c 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -43,13 +43,6 @@ *** xref:configuring-ai-providers.adoc[] **** xref:ai-provider-api-key-secret-reference.adoc[] *** xref:customizing-openshift-che-branding-images.adoc[] -** xref:configuring-oauth-for-git-providers.adoc[] -*** xref:configuring-oauth-2-for-github.adoc[] -*** xref:configuring-oauth-2-for-gitlab.adoc[] -*** xref:configuring-oauth-2-for-a-bitbucket-server.adoc[] -*** xref:configuring-oauth-2-for-the-bitbucket-cloud.adoc[] -*** xref:configuring-oauth-1-for-a-bitbucket-server.adoc[] -*** xref:configuring-oauth-2-for-microsoft-azure-devops-services.adoc[] ** xref:configuring-fuse.adoc[] *** xref:enabling-access-to-dev-fuse-for-openshift.adoc[] *** xref:enabling-fuse-for-all-workspaces.adoc[] diff --git a/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc b/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc index ce49cac804..ba974e0e20 100644 --- a/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc +++ b/modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc @@ -15,7 +15,7 @@ To manage {prod-short} server and {prod-short} dashboard workloads, use the Swag - `pass:c,a,q[{prod-url}]/swagger` ({prod-short} server) - `pass:c,a,q[{prod-url}]/dashboard/swagger` ({prod-short} dashboard) -IMPORTANT: DevWorkspace is a k8s object and manipulations should happen on the Kubernetes API level - xref:end-user-guide:managing-workspaces-with-apis.adoc[] +IMPORTANT: {devworkspace} is a k8s object and manipulations should happen on the {orch-name} API level - xref:integrate:managing-workspaces-with-apis.adoc[] .Additional resources diff --git a/modules/discover/pages/roles-and-tasks.adoc b/modules/discover/pages/roles-and-tasks.adoc index 32d4808276..1abeaa0642 100644 --- a/modules/discover/pages/roles-and-tasks.adoc +++ b/modules/discover/pages/roles-and-tasks.adoc @@ -17,7 +17,7 @@ Common tasks include: * Deploy {prod-short} on a cluster. See xref:install:con_installation-overview.adoc[]. * Configure the `CheCluster` custom resource. See xref:administration-guide:understanding-the-checluster-custom-resource.adoc[]. -* Set up OAuth for Git providers. See xref:administration-guide:configuring-oauth-for-git-providers.adoc[]. +* Set up OAuth for Git providers. See xref:integrate:configuring-oauth-for-git-providers.adoc[]. * Control workspace start times with image caching. See xref:optimize:caching-images-for-faster-workspace-start.adoc[]. * Upgrade to the latest version. See xref:upgrade:upgrading-che.adoc[]. * Monitor metrics and logs. See xref:observe:configuring-observability.adoc[]. diff --git a/modules/end-user-guide/nav.adoc b/modules/end-user-guide/nav.adoc index 5a671cf8c8..48fd57aeee 100644 --- a/modules/end-user-guide/nav.adoc +++ b/modules/end-user-guide/nav.adoc @@ -46,20 +46,7 @@ ** xref:mounting-secrets.adoc[] *** xref:creating-image-pull-secrets.adoc[] *** xref:get-started-user:using-a-git-provider-access-token.adoc[] -*** xref:connecting-to-github-using-device-authorization.adoc[] ** xref:mounting-configmaps.adoc[] *** xref:mounting-git-configuration.adoc[] *** xref:mounting-ssh-configuration.adoc[] -** xref:enabling-artifact-repositories-in-a-restricted-environment.adoc[] -*** xref:enabling-maven-artifact-repositories.adoc[] -*** xref:enabling-gradle-artifact-repositories.adoc[] -*** xref:enabling-npm-artifact-repositories.adoc[] -*** xref:enabling-python-artifact-repositories.adoc[] -*** xref:enabling-go-artifact-repositories.adoc[] -*** xref:enabling-nuget-artifact-repositories.adoc[] * xref:requesting-persistent-storage-for-workspaces.adoc[] -* xref:integrating-with-kubernetes.adoc[] -** xref:managing-workspaces-with-apis.adoc[] -** xref:automatic-token-injection.adoc[] -** xref:navigating-che-from-openshift-developer-perspective.adoc[] -** xref:navigating-openshift-web-console-from-che.adoc[] diff --git a/modules/get-started-admin/pages/configure-github-oauth-for-your-team.adoc b/modules/get-started-admin/pages/configure-github-oauth-for-your-team.adoc index e7d80ea128..da7bc0c74e 100644 --- a/modules/get-started-admin/pages/configure-github-oauth-for-your-team.adoc +++ b/modules/get-started-admin/pages/configure-github-oauth-for-your-team.adoc @@ -67,5 +67,5 @@ EOF [role="_additional-resources"] .Additional resources -* xref:administration-guide:configuring-oauth-for-git-providers.adoc[Connect Git providers with OAuth for GitHub, GitLab, Bitbucket, and Azure DevOps] +* xref:integrate:configuring-oauth-for-git-providers.adoc[Connect Git providers with OAuth for GitHub, GitLab, Bitbucket, and Azure DevOps] * link:https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app[GitHub Docs: Creating an OAuth App] diff --git a/modules/get-started-admin/pages/what-to-configure-next.adoc b/modules/get-started-admin/pages/what-to-configure-next.adoc index 57f4e7c426..2cecfd743a 100644 --- a/modules/get-started-admin/pages/what-to-configure-next.adoc +++ b/modules/get-started-admin/pages/what-to-configure-next.adoc @@ -24,7 +24,7 @@ After verifying the platform and configuring Git access, continue with these con | Recommended | Configure OAuth for additional Git providers (GitLab, Bitbucket, Azure DevOps). -| xref:administration-guide:configuring-oauth-for-git-providers.adoc[Connect Git providers with OAuth] +| xref:integrate:configuring-oauth-for-git-providers.adoc[Connect Git providers with OAuth] | As needed | Control access to {prod-short} with role-based access control. diff --git a/modules/get-started-user/pages/authenticating-to-a-git-server-from-a-workspace.adoc b/modules/get-started-user/pages/authenticating-to-a-git-server-from-a-workspace.adoc index c3b9bff73d..f2602a5c76 100644 --- a/modules/get-started-user/pages/authenticating-to-a-git-server-from-a-workspace.adoc +++ b/modules/get-started-user/pages/authenticating-to-a-git-server-from-a-workspace.adoc @@ -24,6 +24,6 @@ User authentication to a Git server from a cloud development environment is conf // vale RedHat.GitLinks = NO * link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#configuring-devworkspaces-to-use-ssh-keys-for-git-operations[Configuring DevWorkspaces to use SSH keys for Git operations] // vale RedHat.GitLinks = YES -* xref:administration-guide:configuring-oauth-for-git-providers.adoc[Give developers credential-free Git access] +* xref:integrate:configuring-oauth-for-git-providers.adoc[Give developers credential-free Git access] // vale RedHat.CaseSensitiveTerms = YES \ No newline at end of file diff --git a/modules/get-started-user/pages/basic-actions-you-can-perform-on-a-workspace.adoc b/modules/get-started-user/pages/basic-actions-you-can-perform-on-a-workspace.adoc index a31278c2b2..aa1bde96ff 100644 --- a/modules/get-started-user/pages/basic-actions-you-can-perform-on-a-workspace.adoc +++ b/modules/get-started-user/pages/basic-actions-you-can-perform-on-a-workspace.adoc @@ -32,4 +32,4 @@ Stop, restart, and delete cloud development environments from the {prod-short} d |=== -NOTE: Each cloud development environment is an {orch-name} `DevWorkspace` custom resource. You can also manage cloud development environments from the command line with `{orch-cli}` or `kubectl`. See xref:end-user-guide:managing-workspaces-with-apis.adoc[]. +NOTE: Each cloud development environment is an {orch-name} `DevWorkspace` custom resource. You can also manage cloud development environments from the command line with `{orch-cli}` or `kubectl`. See xref:integrate:managing-workspaces-with-apis.adoc[]. diff --git a/modules/install/pages/con_next-steps-after-installation.adoc b/modules/install/pages/con_next-steps-after-installation.adoc index ea58995e02..c2893ca393 100644 --- a/modules/install/pages/con_next-steps-after-installation.adoc +++ b/modules/install/pages/con_next-steps-after-installation.adoc @@ -19,6 +19,6 @@ include::partial$snip_persona-admin.adoc[] .Additional resources * xref:administration-guide:understanding-the-checluster-custom-resource.adoc[] -* xref:administration-guide:configuring-oauth-for-git-providers.adoc[] +* xref:integrate:configuring-oauth-for-git-providers.adoc[] * xref:get-started-user:starting-a-workspace-from-a-git-repository-url.adoc[] * xref:get-started-admin:verify-the-platform-end-to-end.adoc[] diff --git a/modules/end-user-guide/images/installation/che-red-hat-application-menu-che-odp.png b/modules/integrate/images/installation/che-red-hat-application-menu-che-odp.png similarity index 100% rename from modules/end-user-guide/images/installation/che-red-hat-application-menu-che-odp.png rename to modules/integrate/images/installation/che-red-hat-application-menu-che-odp.png diff --git a/modules/end-user-guide/images/installation/edit-source-code-button-che-odp.png b/modules/integrate/images/installation/edit-source-code-button-che-odp.png similarity index 100% rename from modules/end-user-guide/images/installation/edit-source-code-button-che-odp.png rename to modules/integrate/images/installation/edit-source-code-button-che-odp.png diff --git a/modules/end-user-guide/images/integration/token-injection.png b/modules/integrate/images/integration/token-injection.png similarity index 100% rename from modules/end-user-guide/images/integration/token-injection.png rename to modules/integrate/images/integration/token-injection.png diff --git a/modules/end-user-guide/images/navigation/navigating-openshift-web-console-from-che-dashboard.png b/modules/integrate/images/navigation/navigating-openshift-web-console-from-che-dashboard.png similarity index 100% rename from modules/end-user-guide/images/navigation/navigating-openshift-web-console-from-che-dashboard.png rename to modules/integrate/images/navigation/navigating-openshift-web-console-from-che-dashboard.png diff --git a/modules/integrate/nav.adoc b/modules/integrate/nav.adoc new file mode 100644 index 0000000000..2feb7e45bf --- /dev/null +++ b/modules/integrate/nav.adoc @@ -0,0 +1,21 @@ +.Integrate +* xref:configuring-oauth-for-git-providers.adoc[] +** xref:configuring-oauth-2-for-github.adoc[] +** xref:configuring-oauth-2-for-gitlab.adoc[] +** xref:configuring-oauth-2-for-a-bitbucket-server.adoc[] +** xref:configuring-oauth-2-for-the-bitbucket-cloud.adoc[] +** xref:configuring-oauth-1-for-a-bitbucket-server.adoc[] +** xref:configuring-oauth-2-for-microsoft-azure-devops-services.adoc[] +* xref:connecting-to-github-using-device-authorization.adoc[] +* xref:managing-workspaces-with-apis.adoc[] +* xref:integrating-with-kubernetes.adoc[] +** xref:automatic-token-injection.adoc[] +** xref:navigating-che-from-openshift-developer-perspective.adoc[] +** xref:navigating-openshift-web-console-from-che.adoc[] +* xref:enabling-artifact-repositories-in-a-restricted-environment.adoc[] +** xref:enabling-maven-artifact-repositories.adoc[] +** xref:enabling-gradle-artifact-repositories.adoc[] +** xref:enabling-npm-artifact-repositories.adoc[] +** xref:enabling-python-artifact-repositories.adoc[] +** xref:enabling-go-artifact-repositories.adoc[] +** xref:enabling-nuget-artifact-repositories.adoc[] diff --git a/modules/end-user-guide/pages/automatic-token-injection.adoc b/modules/integrate/pages/automatic-token-injection.adoc similarity index 91% rename from modules/end-user-guide/pages/automatic-token-injection.adoc rename to modules/integrate/pages/automatic-token-injection.adoc index da7caa5b67..bac133b6db 100644 --- a/modules/end-user-guide/pages/automatic-token-injection.adoc +++ b/modules/integrate/pages/automatic-token-injection.adoc @@ -1,11 +1,11 @@ :_content-type: PROCEDURE :description: Automatic {orch-name} token injection :keywords: user-guide, token, injection -:navtitle: Automatic {orch-name} token injection +:navtitle: Use automatic {orch-name} token injection :page-aliases: .:automatic-token-injection.adoc, overview:automatic-token-injection.adoc [id="automatic-token-injection"] -= Automatic {orch-name} token injection += Use automatic {orch-name} token injection This section describes how to use the {orch-name} user token that is automatically injected into workspace containers which allows running {prod-short} CLI commands against {orch-name} cluster. diff --git a/modules/administration-guide/pages/configuring-oauth-1-for-a-bitbucket-server.adoc b/modules/integrate/pages/configuring-oauth-1-for-a-bitbucket-server.adoc similarity index 86% rename from modules/administration-guide/pages/configuring-oauth-1-for-a-bitbucket-server.adoc rename to modules/integrate/pages/configuring-oauth-1-for-a-bitbucket-server.adoc index b6ef03bc0f..8a364d4054 100644 --- a/modules/administration-guide/pages/configuring-oauth-1-for-a-bitbucket-server.adoc +++ b/modules/integrate/pages/configuring-oauth-1-for-a-bitbucket-server.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY :description: Configuring OAuth 1.0 for a Bitbucket Server :keywords: configuring-oauth, authorization, bitbucket, bitbucket-server, oauth-1, oauth-1.0 -:navtitle: Configuring OAuth 1.0 for a Bitbucket Server +:navtitle: Connect Bitbucket Server with OAuth 1.0 // :page-aliases: [id="configuring-oauth-1-for-a-bitbucket-server"] -= Configuring OAuth 1.0 for a Bitbucket Server += Connect Bitbucket Server with OAuth 1.0 To enable users to work with a remote Git repository that is hosted on a Bitbucket Server: diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-a-bitbucket-server.adoc b/modules/integrate/pages/configuring-oauth-2-for-a-bitbucket-server.adoc similarity index 87% rename from modules/administration-guide/pages/configuring-oauth-2-for-a-bitbucket-server.adoc rename to modules/integrate/pages/configuring-oauth-2-for-a-bitbucket-server.adoc index 46d2b7e5bc..ad4ec10076 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-a-bitbucket-server.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-a-bitbucket-server.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY :description: Configuring OAuth 2.0 for a Bitbucket Server :keywords: configuring-oauth, authorization, bitbucket, bitbucket-server, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for a Bitbucket Server +:navtitle: Connect Bitbucket Server with OAuth 2.0 // :page-aliases: [id="configuring-oauth-2-for-a-bitbucket-server"] -= Configuring OAuth 2.0 for a Bitbucket Server += Connect Bitbucket Server with OAuth 2.0 You can use OAuth 2.0 to enable users to work with a remote Git repository that is hosted on a Bitbucket Server: diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-github.adoc b/modules/integrate/pages/configuring-oauth-2-for-github.adoc similarity index 93% rename from modules/administration-guide/pages/configuring-oauth-2-for-github.adoc rename to modules/integrate/pages/configuring-oauth-2-for-github.adoc index e1d1dafccb..2e5e861d41 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-github.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-github.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY :description: Configuring OAuth 2.0 for GitHub :keywords: configuring-oauth, authorization, github, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for GitHub +:navtitle: Connect GitHub with OAuth :page-aliases: [id="configuring-oauth-2-for-github"] -= Configuring OAuth 2.0 for GitHub += Connect GitHub with OAuth To enable users to work with a remote Git repository that is hosted on GitHub: diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-gitlab.adoc b/modules/integrate/pages/configuring-oauth-2-for-gitlab.adoc similarity index 88% rename from modules/administration-guide/pages/configuring-oauth-2-for-gitlab.adoc rename to modules/integrate/pages/configuring-oauth-2-for-gitlab.adoc index 0b60e26d41..1acdbaebb7 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-gitlab.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-gitlab.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY :description: Configuring OAuth 2.0 for GitLab :keywords: configuring-oauth, authorization, gitlab, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for GitLab +:navtitle: Connect GitLab with OAuth :page-aliases: [id="configuring-oauth-2-for-gitlab"] -= Configuring OAuth 2.0 for GitLab += Connect GitLab with OAuth To enable users to work with a remote Git repository that is hosted using a GitLab instance: diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc b/modules/integrate/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc similarity index 88% rename from modules/administration-guide/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc rename to modules/integrate/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc index 3c0d804c7d..b43cf3a576 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY :description: Configuring OAuth 2.0 for Microsoft Azure DevOps Services :keywords: configuring-oauth, authorization, microsoft azure devops services, microsoft azure repos, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for Microsoft Azure DevOps Services +:navtitle: Connect Azure DevOps with Microsoft Entra ID :page-aliases: [id="configuring-oauth-2-for-microsoft-azure-devops-services"] -= Configuring OAuth 2.0 for Microsoft Azure DevOps Services += Connect Azure DevOps with Microsoft Entra ID ++++ diff --git a/modules/administration-guide/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc b/modules/integrate/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc similarity index 86% rename from modules/administration-guide/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc rename to modules/integrate/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc index ad977414b4..f7b6308d21 100644 --- a/modules/administration-guide/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc +++ b/modules/integrate/pages/configuring-oauth-2-for-the-bitbucket-cloud.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY :description: Configuring OAuth 2.0 for the Bitbucket Cloud :keywords: configuring-oauth, authorization, bitbucket, bitbucket-cloud, cloud, oauth-2, oauth-2.0 -:navtitle: Configuring OAuth 2.0 for the Bitbucket Cloud +:navtitle: Connect Bitbucket Cloud with OAuth // :page-aliases: [id="configuring-oauth-2-for-the-bitbucket-cloud"] -= Configuring OAuth 2.0 for the Bitbucket Cloud += Connect Bitbucket Cloud with OAuth You can enable users to work with a remote Git repository that is hosted in the Bitbucket Cloud: diff --git a/modules/administration-guide/pages/configuring-oauth-for-git-providers.adoc b/modules/integrate/pages/configuring-oauth-for-git-providers.adoc similarity index 91% rename from modules/administration-guide/pages/configuring-oauth-for-git-providers.adoc rename to modules/integrate/pages/configuring-oauth-for-git-providers.adoc index 96429b64f5..b0848fc85d 100644 --- a/modules/administration-guide/pages/configuring-oauth-for-git-providers.adoc +++ b/modules/integrate/pages/configuring-oauth-for-git-providers.adoc @@ -1,11 +1,11 @@ :_content-type: CONCEPT :description: Configuring OAuth for Git providers :keywords: azure, bitbucket, gitlab, github, git -:navtitle: Configuring OAuth for Git providers +:navtitle: Give developers credential-free Git access // :page-aliases: [id="configuring-oauth-for-git-providers"] -= Configuring OAuth for Git providers += Give developers credential-free Git access [NOTE] ==== diff --git a/modules/end-user-guide/pages/connecting-to-github-using-device-authorization.adoc b/modules/integrate/pages/connecting-to-github-using-device-authorization.adoc similarity index 77% rename from modules/end-user-guide/pages/connecting-to-github-using-device-authorization.adoc rename to modules/integrate/pages/connecting-to-github-using-device-authorization.adoc index 2c4d06323a..28571d002c 100644 --- a/modules/end-user-guide/pages/connecting-to-github-using-device-authorization.adoc +++ b/modules/integrate/pages/connecting-to-github-using-device-authorization.adoc @@ -1,19 +1,22 @@ :_content-type: PROCEDURE :description: Connect your GitHub account to {prod-short} using the device authorization flow directly from the Dashboard. :keywords: user-guide, github, device-authorization, device-auth, token, oauth -:navtitle: Connecting to GitHub using device authorization +:navtitle: Connect to GitHub with device authorization [id="connecting-to-github-using-device-authorization"] -= Connecting to GitHub using device authorization += Connect to GitHub with device authorization [role="_abstract"] Connect your GitHub account to {prod-short} using the device authorization flow directly from the Dashboard. Device Auth Tokens are GitHub OAuth tokens stored as {kubernetes} Secrets. They enable Git operations in your workspaces without requiring a personal access token. .Prerequisites -* Your administrator has configured a GitHub OAuth App with Device Flow enabled as described in xref:administration-guide:configuring-oauth-2-for-github.adoc[Configuring OAuth 2.0 for GitHub]. +* Your administrator has configured a GitHub OAuth App with Device Flow enabled as described in xref:configuring-oauth-2-for-github.adoc[]. + -NOTE: This feature requires the GitHub OAuth App configuration. It is not available when GitHub authentication is configured using a GitHub App. +[NOTE] +==== +This feature requires the GitHub OAuth App configuration. It is not available when GitHub authentication is configured using a GitHub App. +==== .Procedure @@ -27,22 +30,28 @@ A modal opens displaying a one-time code. . Click link:https://github.com/login/device[github.com/login/device] to open the GitHub device activation page. + -NOTE: For GitHub Enterprise Server, replace `github.com` with your instance hostname. +[NOTE] +==== +For GitHub Enterprise Server, replace `github.com` with your instance hostname. +==== . Paste the one-time code on the GitHub page and click *Continue*. . Authorize the application when prompted by GitHub. + -NOTE: The permissions granted are determined by the OAuth App configuration set by your administrator. +[NOTE] +==== +The permissions granted are determined by the OAuth App configuration set by your administrator. +==== + -After successful authorization, the modal closes and the new token appears in the *Device Auth Tokens* table. +After successful authorization, the modal closes and the new token is displayed in the *Device Auth Tokens* table. .Verification * Verify that the new token is listed in the *Device Auth Tokens* table with a valid status. [id="reconnecting-to-github"] -== Reconnecting to GitHub +== Reconnect to GitHub Use *Reconnect* when a token has been revoked or has expired on the GitHub side. Reconnecting starts a new device authorization flow and replaces the existing token in-place, preserving any labels on the {kubernetes} Secret. @@ -57,7 +66,7 @@ Use *Reconnect* when a token has been revoked or has expired on the GitHub side. * Verify that the token card shows a valid status after reconnecting. [id="deleting-device-auth-tokens"] -== Deleting device auth tokens +== Delete a device auth token Deleting a device auth token removes the {kubernetes} Secret and revokes the GitHub authorization. Device Auth Tokens do not expire automatically. To disconnect your GitHub account, delete the token from this page or revoke access from your GitHub account settings. @@ -75,14 +84,15 @@ Deleting a device auth token removes the {kubernetes} Secret and revokes the Git .Verification -* Verify that the deleted token no longer appears in the *Device Auth Tokens* table. +* Verify that the deleted token is no longer displayed in the *Device Auth Tokens* table. [id="troubleshooting-device-auth-tokens"] -== Troubleshooting +== Restart after an expired code If the one-time code expires before you complete the authorization on GitHub (codes expire after approximately 15 minutes), close the modal and click *Connect to GitHub* again to start a new device authorization flow. +[role="_additional-resources"] .Additional resources -* xref:administration-guide:configuring-oauth-2-for-github.adoc[] +* xref:configuring-oauth-2-for-github.adoc[] * For an alternative Git authentication method, see xref:get-started-user:using-a-git-provider-access-token.adoc[]. diff --git a/modules/end-user-guide/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc b/modules/integrate/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc similarity index 85% rename from modules/end-user-guide/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc rename to modules/integrate/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc index f387dceefa..103dd60c9c 100644 --- a/modules/end-user-guide/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc +++ b/modules/integrate/pages/enabling-artifact-repositories-in-a-restricted-environment.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY :description: Enabling artifact repositories in a restricted environment :keywords: artifact-repositories, artifact-repository, maven, gradle, nuget, python, go, npm -:navtitle: Enabling artifact repositories in a restricted environment +:navtitle: Connect workspaces to your organization's package registries :page-aliases: using-artifact-repositories-in-a-restricted-environment.adoc [id="enabling-artifact-repositories-in-a-restricted-environment"] -= Enabling artifact repositories in a restricted environment += Connect workspaces to your organization's package registries By configuring technology stacks, you can work with artifacts from in-house repositories using self-signed certificates: diff --git a/modules/end-user-guide/pages/enabling-go-artifact-repositories.adoc b/modules/integrate/pages/enabling-go-artifact-repositories.adoc similarity index 95% rename from modules/end-user-guide/pages/enabling-go-artifact-repositories.adoc rename to modules/integrate/pages/enabling-go-artifact-repositories.adoc index f5830e78d3..896c8c4845 100644 --- a/modules/end-user-guide/pages/enabling-go-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-go-artifact-repositories.adoc @@ -1,11 +1,11 @@ :_content-type: PROCEDURE :description: You can enable a Go artifact repository in Go workspaces that run in a restricted environment. :keywords: go, artifact-repository, artifact-repositories -:navtitle: Go +:navtitle: Enable Go artifact repositories :page-aliases: using-go-artifact-repositories.adoc [id="enabling-go-artifact-repositories"] -= Enabling Go artifact repositories += Enable Go artifact repositories You can enable a Go artifact repository in Go workspaces that run in a restricted environment. diff --git a/modules/end-user-guide/pages/enabling-gradle-artifact-repositories.adoc b/modules/integrate/pages/enabling-gradle-artifact-repositories.adoc similarity index 96% rename from modules/end-user-guide/pages/enabling-gradle-artifact-repositories.adoc rename to modules/integrate/pages/enabling-gradle-artifact-repositories.adoc index 34d117f313..8e899d91a9 100644 --- a/modules/end-user-guide/pages/enabling-gradle-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-gradle-artifact-repositories.adoc @@ -1,11 +1,11 @@ :_content-type: PROCEDURE :description: You can enable a Gradle artifact repository in Gradle workspaces that run in a restricted environment. :keywords: gradle, artifact-repository, artifact-repositories -:navtitle: Gradle +:navtitle: Enable Gradle artifact repositories :page-aliases: using-gradle-artifact-repositories.adoc [id="enabling-gradle-artifact-repositories"] -= Enabling Gradle artifact repositories += Enable Gradle artifact repositories You can enable a Gradle artifact repository in Gradle workspaces that run in a restricted environment. diff --git a/modules/end-user-guide/pages/enabling-maven-artifact-repositories.adoc b/modules/integrate/pages/enabling-maven-artifact-repositories.adoc similarity index 98% rename from modules/end-user-guide/pages/enabling-maven-artifact-repositories.adoc rename to modules/integrate/pages/enabling-maven-artifact-repositories.adoc index 6513e1e039..02317ca5f8 100644 --- a/modules/end-user-guide/pages/enabling-maven-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-maven-artifact-repositories.adoc @@ -1,11 +1,11 @@ :_content-type: PROCEDURE :description: You can enable a Maven artifact repository in Maven workspaces that run in a restricted environment. :keywords: maven, artifact-repository, artifact-repositories -:navtitle: Maven +:navtitle: Enable Maven artifact repositories :page-aliases: using-maven-artifact-repositories.adoc [id="enabling-maven-artifact-repositories"] -= Enabling Maven artifact repositories += Enable Maven artifact repositories You can enable a Maven artifact repository in Maven workspaces that run in a restricted environment. diff --git a/modules/end-user-guide/pages/enabling-npm-artifact-repositories.adoc b/modules/integrate/pages/enabling-npm-artifact-repositories.adoc similarity index 95% rename from modules/end-user-guide/pages/enabling-npm-artifact-repositories.adoc rename to modules/integrate/pages/enabling-npm-artifact-repositories.adoc index 71138821f5..c7bf697a20 100644 --- a/modules/end-user-guide/pages/enabling-npm-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-npm-artifact-repositories.adoc @@ -1,11 +1,11 @@ :_content-type: PROCEDURE :description: You can enable an npm artifact repository in npm workspaces that run in a restricted environment. :keywords: npm, artifact-repository, artifact-repositories -:navtitle: npm +:navtitle: Enable npm artifact repositories :page-aliases: using-npm-artifact-repositories.adoc [id="enabling-npm-artifact-repositories"] -= Enabling npm artifact repositories += Enable npm artifact repositories You can enable an npm artifact repository in npm workspaces that run in a restricted environment. diff --git a/modules/end-user-guide/pages/enabling-nuget-artifact-repositories.adoc b/modules/integrate/pages/enabling-nuget-artifact-repositories.adoc similarity index 96% rename from modules/end-user-guide/pages/enabling-nuget-artifact-repositories.adoc rename to modules/integrate/pages/enabling-nuget-artifact-repositories.adoc index bec40213b7..02999d7fb6 100644 --- a/modules/end-user-guide/pages/enabling-nuget-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-nuget-artifact-repositories.adoc @@ -1,11 +1,11 @@ :_content-type: PROCEDURE :description: You can enable a NuGet artifact repository in NuGet workspaces that run in a restricted environment. :keywords: nuget, artifact-repository, artifact-repositories -:navtitle: NuGet +:navtitle: Enable NuGet artifact repositories :page-aliases: using-nuget-artifact-repositories.adoc [id="enabling-nuget-artifact-repositories"] -= Enabling NuGet artifact repositories += Enable NuGet artifact repositories You can enable a NuGet artifact repository in NuGet workspaces that run in a restricted environment. diff --git a/modules/end-user-guide/pages/enabling-python-artifact-repositories.adoc b/modules/integrate/pages/enabling-python-artifact-repositories.adoc similarity index 94% rename from modules/end-user-guide/pages/enabling-python-artifact-repositories.adoc rename to modules/integrate/pages/enabling-python-artifact-repositories.adoc index ff400c03f4..5caf2ce39b 100644 --- a/modules/end-user-guide/pages/enabling-python-artifact-repositories.adoc +++ b/modules/integrate/pages/enabling-python-artifact-repositories.adoc @@ -1,11 +1,11 @@ :_content-type: PROCEDURE :description: You can enable a Python artifact repository in Python workspaces that run in a restricted environment. :keywords: python, artifact-repository, artifact-repositories -:navtitle: Python +:navtitle: Enable Python artifact repositories :page-aliases: using-python-artifact-repositories.adoc [id="enabling-python-artifact-repositories"] -= Enabling Python artifact repositories += Enable Python artifact repositories You can enable a Python artifact repository in Python workspaces that run in a restricted environment. diff --git a/modules/end-user-guide/pages/integrating-with-kubernetes.adoc b/modules/integrate/pages/integrating-with-kubernetes.adoc similarity index 78% rename from modules/end-user-guide/pages/integrating-with-kubernetes.adoc rename to modules/integrate/pages/integrating-with-kubernetes.adoc index 69ad1f1c31..8c7c8f5177 100644 --- a/modules/end-user-guide/pages/integrating-with-kubernetes.adoc +++ b/modules/integrate/pages/integrating-with-kubernetes.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY :description: Integrating with {orch-name} :keywords: overview, integrating with {orch-name} -:navtitle: Integrating with {orch-name} +:navtitle: Use {orch-name} tools with workspaces :page-aliases: [id="integrating-with-kubernetes"] -= Integrating with {orch-name} += Use {orch-name} tools with workspaces * xref:automatic-token-injection.adoc[] * xref:navigating-che-from-openshift-developer-perspective.adoc[] diff --git a/modules/end-user-guide/pages/managing-workspaces-with-apis.adoc b/modules/integrate/pages/managing-workspaces-with-apis.adoc similarity index 93% rename from modules/end-user-guide/pages/managing-workspaces-with-apis.adoc rename to modules/integrate/pages/managing-workspaces-with-apis.adoc index 8e610dd4b5..74b7e04c19 100644 --- a/modules/end-user-guide/pages/managing-workspaces-with-apis.adoc +++ b/modules/integrate/pages/managing-workspaces-with-apis.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY -:navtitle: Managing workspaces with {orch-name} APIs +:navtitle: Manage workspaces from the command line :description: Managing workspaces with {orch-name} APIs :keywords: api, list workspaces, create workspace, restart workspace, stop workspace, start workspace, remove workspace // :page-aliases: [id="managing-workspaces-with-apis"] -= Managing workspaces with {orch-name} APIs += Manage workspaces from the command line On your organization's {orch-name} cluster, {prod-short} workspaces are represented as `DevWorkspace` custom resources of the same name. As a result, if there is a workspace named `my-workspace` in the {prod-short} dashboard, there is a corresponding `DevWorkspace` custom resource named `my-workspace` in the user's {orch-namespace} on the cluster. diff --git a/modules/end-user-guide/pages/navigating-che-from-openshift-developer-perspective.adoc b/modules/integrate/pages/navigating-che-from-openshift-developer-perspective.adoc similarity index 94% rename from modules/end-user-guide/pages/navigating-che-from-openshift-developer-perspective.adoc rename to modules/integrate/pages/navigating-che-from-openshift-developer-perspective.adoc index 728e4af20a..71ae3636c1 100644 --- a/modules/end-user-guide/pages/navigating-che-from-openshift-developer-perspective.adoc +++ b/modules/integrate/pages/navigating-che-from-openshift-developer-perspective.adoc @@ -1,12 +1,12 @@ :_content-type: ASSEMBLY :description: Navigating {prod-short} from OpenShift Developer Perspective :keywords: overview, accessing-che-from-openshift-developer-perspective -:navtitle: Navigating {prod-short} from OpenShift Developer Perspective +:navtitle: {prod-short} in the OpenShift Developer Perspective :page-aliases: .:accessing-che-from-openshift-developer-perspective.adoc, overview:accessing-che-from-openshift-developer-perspective.adoc, accessing-che-from-openshift-developer-perspective.adoc [id="navigating-{prod-id-short}-from-openshift-developer-perspective"] -= Navigating {prod-short} from OpenShift Developer Perspective += {prod-short} in the OpenShift Developer Perspective The OpenShift Container Platform web console provides two perspectives; the *Administrator* perspective and the *Developer* perspective. diff --git a/modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc b/modules/integrate/pages/navigating-openshift-web-console-from-che.adoc similarity index 88% rename from modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc rename to modules/integrate/pages/navigating-openshift-web-console-from-che.adoc index 9f439d4a8a..92f3d533d4 100644 --- a/modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc +++ b/modules/integrate/pages/navigating-openshift-web-console-from-che.adoc @@ -1,12 +1,12 @@ :_content-type: PROCEDURE :description: Navigating OpenShift web console from {prod-short} :keywords: overview, OpenShift, web console -:navtitle: Navigating OpenShift web console from {prod-short} +:navtitle: Navigate to the {orch-name} web console from {prod-short} :page-aliases: .:accessing-openshift-web-console-from-che.adoc, overview:accessing-openshift-web-console-from-che.adoc, accessing-openshift-web-console-from-che.adoc [id="navigating-openshift-web-console-from-{prod-id-short}"] -= Navigating OpenShift web console from {prod-short} += Navigate to the {orch-name} web console from {prod-short} This section describes how to access OpenShift web console from {prod-short}. diff --git a/modules/end-user-guide/partials/con_openshift-developer-perspective-integration-with-che.adoc b/modules/integrate/partials/con_openshift-developer-perspective-integration-with-che.adoc similarity index 100% rename from modules/end-user-guide/partials/con_openshift-developer-perspective-integration-with-che.adoc rename to modules/integrate/partials/con_openshift-developer-perspective-integration-with-che.adoc diff --git a/modules/end-user-guide/partials/proc_accessing-che-from-red-hat-applications-menu.adoc b/modules/integrate/partials/proc_accessing-che-from-red-hat-applications-menu.adoc similarity index 100% rename from modules/end-user-guide/partials/proc_accessing-che-from-red-hat-applications-menu.adoc rename to modules/integrate/partials/proc_accessing-che-from-red-hat-applications-menu.adoc diff --git a/modules/administration-guide/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc b/modules/integrate/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc similarity index 100% rename from modules/administration-guide/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc rename to modules/integrate/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc diff --git a/modules/administration-guide/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc b/modules/integrate/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc similarity index 100% rename from modules/administration-guide/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc rename to modules/integrate/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc diff --git a/modules/administration-guide/partials/proc_applying-an-oauth-client-secret-for-the-bitbucket-cloud.adoc b/modules/integrate/partials/proc_applying-an-oauth-client-secret-for-the-bitbucket-cloud.adoc similarity index 100% rename from modules/administration-guide/partials/proc_applying-an-oauth-client-secret-for-the-bitbucket-cloud.adoc rename to modules/integrate/partials/proc_applying-an-oauth-client-secret-for-the-bitbucket-cloud.adoc diff --git a/modules/administration-guide/partials/proc_applying-the-github-oauth-app-secret.adoc b/modules/integrate/partials/proc_applying-the-github-oauth-app-secret.adoc similarity index 100% rename from modules/administration-guide/partials/proc_applying-the-github-oauth-app-secret.adoc rename to modules/integrate/partials/proc_applying-the-github-oauth-app-secret.adoc diff --git a/modules/administration-guide/partials/proc_applying-the-gitlab-authorized-application-secret.adoc b/modules/integrate/partials/proc_applying-the-gitlab-authorized-application-secret.adoc similarity index 100% rename from modules/administration-guide/partials/proc_applying-the-gitlab-authorized-application-secret.adoc rename to modules/integrate/partials/proc_applying-the-gitlab-authorized-application-secret.adoc diff --git a/modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc b/modules/integrate/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc similarity index 100% rename from modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc rename to modules/integrate/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc diff --git a/modules/end-user-guide/partials/proc_creating-workspaces.adoc b/modules/integrate/partials/proc_creating-workspaces.adoc similarity index 100% rename from modules/end-user-guide/partials/proc_creating-workspaces.adoc rename to modules/integrate/partials/proc_creating-workspaces.adoc diff --git a/modules/end-user-guide/partials/proc_disabling-self-signed-certificate-validation.adoc b/modules/integrate/partials/proc_disabling-self-signed-certificate-validation.adoc similarity index 100% rename from modules/end-user-guide/partials/proc_disabling-self-signed-certificate-validation.adoc rename to modules/integrate/partials/proc_disabling-self-signed-certificate-validation.adoc diff --git a/modules/end-user-guide/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc b/modules/integrate/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc similarity index 100% rename from modules/end-user-guide/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc rename to modules/integrate/partials/proc_editing-the-code-of-applications-running-in-openshift-container-platform-using-che.adoc diff --git a/modules/end-user-guide/partials/proc_listing-workspaces.adoc b/modules/integrate/partials/proc_listing-workspaces.adoc similarity index 100% rename from modules/end-user-guide/partials/proc_listing-workspaces.adoc rename to modules/integrate/partials/proc_listing-workspaces.adoc diff --git a/modules/end-user-guide/partials/proc_removing-workspaces.adoc b/modules/integrate/partials/proc_removing-workspaces.adoc similarity index 100% rename from modules/end-user-guide/partials/proc_removing-workspaces.adoc rename to modules/integrate/partials/proc_removing-workspaces.adoc diff --git a/modules/end-user-guide/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc b/modules/integrate/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc similarity index 100% rename from modules/end-user-guide/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc rename to modules/integrate/partials/proc_restoring-node-extra-ca-certs-variable-value.adoc diff --git a/modules/administration-guide/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc b/modules/integrate/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc similarity index 100% rename from modules/administration-guide/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc rename to modules/integrate/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc diff --git a/modules/administration-guide/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc b/modules/integrate/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc similarity index 100% rename from modules/administration-guide/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc rename to modules/integrate/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc diff --git a/modules/administration-guide/partials/proc_setting-up-an-oauth-client-in-the-bitbucket-cloud.adoc b/modules/integrate/partials/proc_setting-up-an-oauth-client-in-the-bitbucket-cloud.adoc similarity index 100% rename from modules/administration-guide/partials/proc_setting-up-an-oauth-client-in-the-bitbucket-cloud.adoc rename to modules/integrate/partials/proc_setting-up-an-oauth-client-in-the-bitbucket-cloud.adoc diff --git a/modules/administration-guide/partials/proc_setting-up-the-github-app.adoc b/modules/integrate/partials/proc_setting-up-the-github-app.adoc similarity index 100% rename from modules/administration-guide/partials/proc_setting-up-the-github-app.adoc rename to modules/integrate/partials/proc_setting-up-the-github-app.adoc diff --git a/modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc b/modules/integrate/partials/proc_setting-up-the-github-oauth-app.adoc similarity index 80% rename from modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc rename to modules/integrate/partials/proc_setting-up-the-github-oauth-app.adoc index f561754bbe..8c801cd0f1 100644 --- a/modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc +++ b/modules/integrate/partials/proc_setting-up-the-github-oauth-app.adoc @@ -34,7 +34,10 @@ Set up a GitHub OAuth App using OAuth 2.0. . *(Optional)* Scroll to the *Device flow* section and select the *Enable Device Flow* checkbox. + -NOTE: Enable this option to allow users to connect their GitHub accounts from the {prod-short} Dashboard using *User Preferences > Device Auth Tokens*. See xref:end-user-guide:connecting-to-github-using-device-authorization.adoc[]. +[NOTE] +==== +Enable this option to allow users to connect their GitHub accounts from the {prod-short} Dashboard by using *User Preferences > Device Auth Tokens*. See xref:connecting-to-github-using-device-authorization.adoc[]. +==== . If you selected *Enable Device Flow*, click *Update application*. @@ -47,7 +50,10 @@ $ {orch-cli} create configmap device-auth-config \ -n {prod-namespace} ---- + -NOTE: When this ConfigMap is present, the *Connect to GitHub* button appears in *User Preferences > Device Auth Tokens*. Delete the ConfigMap to hide the button. +[NOTE] +==== +When this ConfigMap is present, the *Connect to GitHub* button is displayed in *User Preferences > Device Auth Tokens*. Delete the ConfigMap to hide the button. +==== .Additional resources diff --git a/modules/administration-guide/partials/proc_setting-up-the-gitlab-authorized-application.adoc b/modules/integrate/partials/proc_setting-up-the-gitlab-authorized-application.adoc similarity index 100% rename from modules/administration-guide/partials/proc_setting-up-the-gitlab-authorized-application.adoc rename to modules/integrate/partials/proc_setting-up-the-gitlab-authorized-application.adoc diff --git a/modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc b/modules/integrate/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc similarity index 100% rename from modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc rename to modules/integrate/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc diff --git a/modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc b/modules/integrate/partials/proc_starting-stopped-workspaces.adoc similarity index 100% rename from modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc rename to modules/integrate/partials/proc_starting-stopped-workspaces.adoc diff --git a/modules/end-user-guide/partials/proc_stopping-workspaces.adoc b/modules/integrate/partials/proc_stopping-workspaces.adoc similarity index 100% rename from modules/end-user-guide/partials/proc_stopping-workspaces.adoc rename to modules/integrate/partials/proc_stopping-workspaces.adoc diff --git a/modules/end-user-guide/partials/snip_warning-about-applying-a-configmap-that-sets-environment-variables.adoc b/modules/integrate/partials/snip_warning-about-applying-a-configmap-that-sets-environment-variables.adoc similarity index 100% rename from modules/end-user-guide/partials/snip_warning-about-applying-a-configmap-that-sets-environment-variables.adoc rename to modules/integrate/partials/snip_warning-about-applying-a-configmap-that-sets-environment-variables.adoc diff --git a/modules/secure/pages/security-best-practices.adoc b/modules/secure/pages/security-best-practices.adoc index c19a46b45c..33f4b376e8 100644 --- a/modules/secure/pages/security-best-practices.adoc +++ b/modules/secure/pages/security-best-practices.adoc @@ -111,16 +111,16 @@ The following table lists the resources and actions that you can grant users per |projects |"get" -|devworkspace +|`devworkspaces` |"get", "create", "delete", "list", "update", "patch", "watch" -|devworkspacetemplates +|`devworkspacetemplates` |"get", "create", "delete", "list", "update", "patch", "watch" |=== [IMPORTANT] ==== -Each user is granted permissions only to their namespace and cannot access other users' resources. Cluster administrators can add extra permissions to users. They should not remove permissions granted by default. +Each user is granted permissions only to their {namespace} and cannot access other users' resources. Cluster administrators can add extra permissions to users. They should not remove permissions granted by default. For more details about configuring cluster roles for {prod} users and role-based access control, see the Additional resources section. ==== @@ -136,7 +136,7 @@ Isolation of the development environments is implemented using OpenShift project [IMPORTANT] ==== -Access to the resources in a namespace must be limited to the developer owning it. Granting read access to another developer is equivalent to sharing the developer credentials and should be avoided. +Access to the resources in a {namespace} must be limited to the developer owning it. Granting read access to another developer is equivalent to sharing the developer credentials and should be avoided. ==== == Restrict platform access with allow and deny lists @@ -243,7 +243,7 @@ For credential-free Git access that reduces token sprawl, see Additional resourc * xref:administration-guide:provisioning-namespaces-in-advance.adoc[] * xref:configuring-cluster-roles-for-users.adoc[] * xref:configuring-advanced-authorization.adoc[] -* xref:administration-guide:configuring-oauth-for-git-providers.adoc[] +* xref:integrate:configuring-oauth-for-git-providers.adoc[] * xref:end-user-guide:using-credentials-and-configurations-in-workspaces.adoc[] * link:https://docs.openshift.com/container-platform/{ocp4-ver}/authentication/using-rbac.html[OpenShift role-based access control] * link:https://docs.openshift.com/container-platform/{ocp4-ver}/applications/quotas/quotas-setting-per-project.html[Resource quotas per project]