Skip to content

chore: promote Integrate to top-level Antora module (JTBD Phase 3) #3151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gtrivedi88 wants to merge 1 commit into
base: main
Choose a base branch
from
+354 −375
Open

chore: promote Integrate to top-level Antora module (JTBD Phase 3) #3151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@ yarn.lock

# Do not commit diagrams generated for downstream
crw*
CLAUDE.md
1 change: 1 addition & 0 deletions antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ nav:
- modules/upgrade/nav.adoc
- modules/secure/nav.adoc
- modules/optimize/nav.adoc
- modules/integrate/nav.adoc
- modules/administration-guide/nav.adoc
- modules/extensions/nav.adoc
- modules/glossary/nav.adoc
Expand Down
7 changes: 0 additions & 7 deletions modules/administration-guide/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,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[]
Expand Down
2 changes: 1 addition & 1 deletion ...les/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/api/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 Kubernetes API level - xref:integrate:managing-workspaces-with-apis.adoc[]

.Additional resources

Expand Down
2 changes: 1 addition & 1 deletion modules/discover/pages/roles-and-tasks.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Common tasks include:

* Deploy {prod-short} on a cluster. See xref:install:installing-che.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[].
* Upgrade to the latest version. See xref:administration-guide:upgrading-che.adoc[].
* Monitor metrics and logs. See xref:administration-guide:configuring-observability.adoc[].

Expand Down
12 changes: 0 additions & 12 deletions modules/end-user-guide/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,7 @@
** 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[]
* xref:troubleshooting-che.adoc[]
** xref:viewing-che-workspaces-logs.adoc[]
*** xref:viewing-workspace-logs-in-cli.adoc[]
Expand Down
6 changes: 2 additions & 4 deletions modules/end-user-guide/pages/authenticating-to-a-git-server-from-a-workspace.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,17 @@
[id="authenticating-to-a-git-server-from-a-workspace"]
= Authenticating to a Git server from a workspace

pass:[<!-- vale RedHat.CaseSensitiveTerms = NO -->]

In a workspace, you can run Git commands that require user authentication like cloning a remote private Git repository or pushing to a remote public or private Git repository.

User authentication to a Git server from a workspace is configured by the administrator or, in some cases, by the individual user:

* Your administrator sets up an xref:administration-guide:configuring-oauth-for-git-providers.adoc[OAuth application on GitHub, GitLab, Bitbucket, or Microsoft Azure Repos] for your organization's {prod} instance.
* Your administrator sets up an xref:integrate:configuring-oauth-for-git-providers.adoc[OAuth application on GitHub, GitLab, Bitbucket, or Microsoft Azure Repos] for your organization's {prod} instance.

* As a workaround, some users create and apply their own {kubernetes} Secrets for their personal xref:using-a-git-provider-access-token.adoc[Git-provider access tokens] or link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#configuring-devworkspaces-to-use-ssh-keys-for-git-operations[configure SSH keys for Git operations].

.Additional resources
* xref:administration-guide:configuring-oauth-for-git-providers.adoc[Administration Guide: Configuring OAuth for Git providers]
* xref:integrate:configuring-oauth-for-git-providers.adoc[Administration Guide: Configuring OAuth for Git providers]
* xref:using-a-git-provider-access-token.adoc[User Guide: Using a Git-provider access token]
* 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]

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]
23 changes: 0 additions & 23 deletions modules/end-user-guide/pages/automatic-token-injection.adoc
View file
Open in desktop

This file was deleted.

4 changes: 1 addition & 3 deletions modules/end-user-guide/pages/using-a-git-provider-access-token.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@
[id="using-a-git-provider-access-token"]
= Using a Git-provider access token

pass:[<!-- vale RedHat.CaseSensitiveTerms = NO -->]

OAuth for GitHub, GitLab, Bitbucket, or Microsoft Azure Repos needs to be xref:administration-guide:configuring-oauth-for-git-providers.adoc[configured by the administrator] of your organization's {prod-short} instance. If your administrator could not configure it for {prod-short} users, the workaround is for you to use a personal access token. You can configure personal access tokens on the *User Preferences* page of your {prod-short} dashboard: `pass:c,a,q[{prod-url}]/dashboard/#/user-preferences?tab=personal-access-tokens`, or apply it manually as a {kubernetes} Secret in the namespace.
OAuth for GitHub, GitLab, Bitbucket, or Microsoft Azure Repos needs to be xref:integrate:configuring-oauth-for-git-providers.adoc[configured by the administrator] of your organization's {prod-short} instance. If your administrator could not configure it for {prod-short} users, the workaround is for you to use a personal access token. You can configure personal access tokens on the *User Preferences* page of your {prod-short} dashboard: `pass:c,a,q[{prod-url}]/dashboard/#/user-preferences?tab=personal-access-tokens`, or apply it manually as a {kubernetes} Secret in the namespace.

Mounting your access token as a Secret enables the {prod-short} Server to access the remote repository that is cloned during workspace creation, including access to the repository's `/.che` and `/.vscode` folders.

Expand Down Expand Up @@ -147,7 +146,6 @@ The `extraheader` configuration is needed for remote git operations to Azure Dev
* xref:administration-guide:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[Deploying Che with support for Git repositories with self-signed certificates]
* link:https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on[Authorizing a personal access token for use with SAML single sign-on]

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]



Expand Down
49 changes: 0 additions & 49 deletions modules/end-user-guide/partials/proc_listing-workspaces.adoc
View file
Open in desktop

This file was deleted.

40 changes: 0 additions & 40 deletions modules/end-user-guide/partials/proc_removing-workspaces.adoc
View file
Open in desktop

This file was deleted.

40 changes: 0 additions & 40 deletions modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc
View file
Open in desktop

This file was deleted.

40 changes: 0 additions & 40 deletions modules/end-user-guide/partials/proc_stopping-workspaces.adoc
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion modules/install/pages/con_next-steps-after-installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ After a successful installation, a few configuration tasks remain before your te
.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:end-user-guide:starting-a-workspace-from-a-git-repository-url.adoc[]
0 .../che-red-hat-application-menu-che-odp.png → .../che-red-hat-application-menu-che-odp.png
View file
Open in desktop
File renamed without changes
0 ...ation/edit-source-code-button-che-odp.png → ...ation/edit-source-code-button-che-odp.png
View file
Open in desktop
File renamed without changes
0 ...de/images/integration/token-injection.png → ...te/images/integration/token-injection.png
View file
Open in desktop
File renamed without changes
0 ...nshift-web-console-from-che-dashboard.png → ...nshift-web-console-from-che-dashboard.png
View file
Open in desktop
File renamed without changes
20 changes: 20 additions & 0 deletions modules/integrate/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.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: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[]
27 changes: 27 additions & 0 deletions modules/integrate/pages/automatic-token-injection.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
:_content-type: PROCEDURE
:description: Use automatic {orch-name} token injection
:keywords: user-guide, token, injection
:navtitle: Use automatic {orch-name} token injection
:page-aliases: .:automatic-token-injection.adoc, overview:automatic-token-injection.adoc

[id="automatic-token-injection"]
= Use automatic {orch-name} token injection

Use the {orch-name} user token that is automatically injected into workspace containers to run `{orch-cli}` and `kubectl` commands against the {orch-name} cluster without explicit login.

WARNING: The automatic token injection currently works only on the OpenShift infrastructure.

.Prerequisites

* You have a running instance of {prod}.

.Procedure

. Open the {prod-short} dashboard and start a workspace.

. After the workspace starts, open a terminal in the workspace container.

. Run `{orch-cli}` or `kubectl` commands to deploy applications, inspect and manage cluster resources, or view logs. The injected {orch-name} user token authenticates these commands automatically.

+
image::integration/token-injection.png[Token Injection in IDE,link="{imagesdir}/integration/token-injection.png"]
4 changes: 2 additions & 2 deletions ...uring-oauth-1-for-a-bitbucket-server.adoc → ...uring-oauth-1-for-a-bitbucket-server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
4 changes: 2 additions & 2 deletions ...uring-oauth-2-for-a-bitbucket-server.adoc → ...uring-oauth-2-for-a-bitbucket-server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
Loading
Loading