docs: rename Bitbucket OAuth consumer to OAuth client by vinokurig · Pull Request #3171 · eclipse-che/che-docs

vinokurig · 2026-07-27T12:42:25Z

What does this pull request change?

Bitbucket Cloud updated their terminology from "OAuth consumer" to "OAuth client". Updated procedure files to reflect the new naming and revised UI steps.

What issues does this pull request fix or reference?

https://redhat.atlassian.net/browse/CRW-11735

Specify the version of the product this pull request applies to

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
Builds on Eclipse Che hosted by Red Hat.
the Validate language on files added or modified step reports no vale warnings.

github-actions · 2026-07-27T12:42:34Z

Click here to review and test in web IDE:

github-actions · 2026-07-27T12:42:35Z

🎊 Navigate the preview: https://6a6753de94edff2b03ea3d34--eclipse-che-docs-pr.netlify.app 🎊

Bitbucket Cloud updated their terminology from "OAuth consumer" to "OAuth client". Updated procedure files to reflect the new naming and revised UI steps. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

gtrivedi88

JTBD + CQA 2.1 review

JTBD mapping

This content maps to Integrate > Enable credential-free Git access for developers (integrate_git), specifically Job 32: Enable credential-free Git access for developers — "When connecting to version control, I want to enable credential-free authentication with our Git providers so that developers can push and pull code without managing individual credentials."

Upstream JTBD PR: #3151 (Integrate)

PR #3151 moves the OAuth configuration pages from modules/administration-guide/ into the Integrate module. Same situation as PR #3170:

Option A (preferred): Merge #3171 first since it is a small terminology fix. When #3151 rebases, it picks up the renamed files and updated terminology automatically. The file moves cleanly because #3151 does a git mv of the entire partials directory.

Option B: Merge #3151 first, then rebase #3171 to target the new Integrate module paths. Either way works — this is a simpler case than #3170 because the files are just renamed/replaced, not restructured.

gtrivedi88 · 2026-07-27T14:21:52Z

+. In the *Details* tab enter *{prod-short}* as the *Name*.
+
+. In the *Authorization* tab click the *Authorization code* checkbox and enter `pass:c,a,q[{prod-url}]/api/oauth/callback` as the *Callback URL*.
+


Typo: "Copes" should be "Scopes"

Suggested change

. In the *Scopes* tab check all of the *Account* and *Repositories* checkboxes, and click *Save*.

gtrivedi88 · 2026-07-27T14:21:52Z

+// :page-aliases:
+
+[id="setting-up-an-oauth-client-in-the-bitbucket-cloud"]
+= Setting up an OAuth client in the Bitbucket Cloud


Gerund title — use imperative

Per CQA 2.1 and JTBD title rules, procedure titles must use imperative verbs. Also update the :navtitle: and :description: to match.

Suggested change

= Setting up an OAuth client in the Bitbucket Cloud

= Set up an OAuth client in the Bitbucket Cloud

Note: The downstream JTBD title for this procedure is "Create a Bitbucket Cloud OAuth client for {prod-short}" — even more user-goal-driven. Consider aligning upstream with a similar pattern.

gtrivedi88 · 2026-07-27T14:21:52Z

+. In the *Authorization* tab click the *Authorization code* checkbox and enter `pass:c,a,q[{prod-url}]/api/oauth/callback` as the *Callback URL*.
+
+. In the *Copes* tab check all of the *Account* and *Repositories* checkboxes, and click *Save*.
+


Trailing colon should be a period

Line ends with : instead of .

Suggested change

. Copy and save the *Client ID* value for use when applying the Bitbucket OAuth client Secret.

gtrivedi88 · 2026-07-27T14:21:52Z

+. Copy and save the *Client ID* value for use when applying the Bitbucket OAuth client Secret:
+
+. Copy and save the *Secret* value for use when applying the Bitbucket OAuth client Secret.
+


Missing [role="_additional-resources"]

Per DITA compliance, the role attribute is required before .Additional resources.

Suggested change

[role="_additional-resources"]

.Additional resources

gtrivedi88 · 2026-07-27T14:21:52Z

+:keywords: bitbucket, bitbucket-cloud, oauth-client, bitbucket-oauth-client, oauth-application
+:navtitle: Setting up an OAuth client in the Bitbucket Cloud
+// :page-aliases:
+


Missing :page-aliases: for URL redirect

The old file proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc was deleted and this new file replaces it. To avoid breaking existing bookmarks and search engine links, add a page alias:

Suggested change

[id="setting-up-an-oauth-client-in-the-bitbucket-cloud"]

Also consider adding :page-aliases: proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc to the metadata.

gtrivedi88 · 2026-07-27T14:21:52Z

-[id="applying-an-oauth-consumer-secret-for-the-bitbucket-cloud"]
-= Applying an OAuth consumer Secret for the Bitbucket Cloud
+[id="applying-an-oauth-client-secret-for-the-bitbucket-cloud"]
+= Applying an OAuth client Secret for the Bitbucket Cloud


Gerund title — use imperative

Suggested change

= Applying an OAuth client Secret for the Bitbucket Cloud

= Apply an OAuth client Secret for the Bitbucket Cloud

Also update :navtitle: and :description: to match.

gtrivedi88 · 2026-07-27T14:21:52Z

+= Applying an OAuth client Secret for the Bitbucket Cloud

-Prepare and apply an OAuth consumer Secret for the Bitbucket Cloud.
+Prepare and apply an OAuth client Secret for the Bitbucket Cloud.


Title-abstract verb mismatch

Title verb is "Applying" (or after fix: "Apply"), but the abstract starts with "Prepare". Per CQA 2.1, the first verb in the title must match the first verb in the abstract.

Suggested change

Prepare and apply an OAuth client Secret for the Bitbucket Cloud.

Apply an OAuth client Secret for the Bitbucket Cloud.

gtrivedi88 · 2026-07-27T14:21:52Z

 stringData:
-  id: __<Bitbucket_Oauth_Consumer_Key>__ <2>
-  secret: __<Bitbucket_Oauth_Consumer_Secret>__ <3>
+  id: __<Bitbucket_Oauth_client_Key>__ <2>


Inconsistent casing in YAML placeholders

Oauth should be OAuth (capital A), and client should be Client for consistency with the proper noun "OAuth client".

Suggested change

id: __<Bitbucket_Oauth_client_Key>__ <2>

id: __<Bitbucket_OAuth_Client_Key>__ <2>

secret: __<Bitbucket_OAuth_Client_Secret>__ <3>

gtrivedi88 · 2026-07-27T14:21:52Z

@@ -12,6 +12,6 @@ You can enable users to work with a remote Git repository that is hosted in the
 . Set up an OAuth consumer (OAuth 2.0) in the Bitbucket Cloud.


Parent page lead-in text not updated

The include paths were updated but the lead-in text still says "OAuth consumer". This should be updated to match the new Bitbucket terminology:

Suggested change

. Set up an OAuth consumer (OAuth 2.0) in the Bitbucket Cloud.

. Set up an OAuth client (OAuth 2.0) in the Bitbucket Cloud.

. Apply an OAuth client Secret for the Bitbucket Cloud.

vinokurig requested review from a team, deerskindoll, gtrivedi88 and mkuznyetsov as code owners July 27, 2026 12:42

vinokurig requested a review from svor July 27, 2026 12:42

docs: rename Bitbucket OAuth consumer to OAuth client

37fe970

Bitbucket Cloud updated their terminology from "OAuth consumer" to "OAuth client". Updated procedure files to reflect the new naming and revised UI steps. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

vinokurig force-pushed the CRW-11735 branch from f01c7a3 to 37fe970 Compare July 27, 2026 12:43

gtrivedi88 reviewed Jul 27, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: rename Bitbucket OAuth consumer to OAuth client - #3171

docs: rename Bitbucket OAuth consumer to OAuth client#3171
vinokurig wants to merge 1 commit into
mainfrom
CRW-11735

vinokurig commented Jul 27, 2026

Uh oh!

github-actions Bot commented Jul 27, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 27, 2026 •

edited

Loading

Uh oh!

gtrivedi88 left a comment •

edited

Loading

Uh oh!

gtrivedi88 Jul 27, 2026

Uh oh!

gtrivedi88 Jul 27, 2026

Uh oh!

gtrivedi88 Jul 27, 2026

Uh oh!

gtrivedi88 Jul 27, 2026

Uh oh!

gtrivedi88 Jul 27, 2026

Uh oh!

gtrivedi88 Jul 27, 2026

Uh oh!

gtrivedi88 Jul 27, 2026

Uh oh!

gtrivedi88 Jul 27, 2026

Uh oh!

gtrivedi88 Jul 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		. In the Details tab enter {prod-short} as the Name.

		. In the Authorization tab click the Authorization code checkbox and enter `pass:c,a,q[{prod-url}]/api/oauth/callback` as the Callback URL.


	. In the Scopes tab check all of the Account and Repositories checkboxes, and click Save.

	= Setting up an OAuth client in the Bitbucket Cloud
	= Set up an OAuth client in the Bitbucket Cloud

		. In the Authorization tab click the Authorization code checkbox and enter `pass:c,a,q[{prod-url}]/api/oauth/callback` as the Callback URL.

		. In the Copes tab check all of the Account and Repositories checkboxes, and click Save.


	. Copy and save the Client ID value for use when applying the Bitbucket OAuth client Secret.

		. Copy and save the Client ID value for use when applying the Bitbucket OAuth client Secret:

		. Copy and save the Secret value for use when applying the Bitbucket OAuth client Secret.

	= Applying an OAuth client Secret for the Bitbucket Cloud
	= Apply an OAuth client Secret for the Bitbucket Cloud

	Prepare and apply an OAuth client Secret for the Bitbucket Cloud.
	Apply an OAuth client Secret for the Bitbucket Cloud.

	id: __<Bitbucket_Oauth_client_Key>__ <2>
	id: __<Bitbucket_OAuth_Client_Key>__ <2>
	secret: __<Bitbucket_OAuth_Client_Secret>__ <3>

		@@ -12,6 +12,6 @@ You can enable users to work with a remote Git repository that is hosted in the
		. Set up an OAuth consumer (OAuth 2.0) in the Bitbucket Cloud.

	. Set up an OAuth consumer (OAuth 2.0) in the Bitbucket Cloud.
	. Set up an OAuth client (OAuth 2.0) in the Bitbucket Cloud.
	. Apply an OAuth client Secret for the Bitbucket Cloud.

Uh oh!

Conversation

vinokurig commented Jul 27, 2026

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

Uh oh!

github-actions Bot commented Jul 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gtrivedi88 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

JTBD + CQA 2.1 review

JTBD mapping

Upstream JTBD PR: #3151 (Integrate)

Uh oh!

Choose a reason for hiding this comment

Typo: "Copes" should be "Scopes"

Uh oh!

Choose a reason for hiding this comment

Gerund title — use imperative

Uh oh!

Choose a reason for hiding this comment

Trailing colon should be a period

Uh oh!

Choose a reason for hiding this comment

Missing [role="_additional-resources"]

Uh oh!

Choose a reason for hiding this comment

Missing :page-aliases: for URL redirect

Uh oh!

Choose a reason for hiding this comment

Gerund title — use imperative

Uh oh!

Choose a reason for hiding this comment

Title-abstract verb mismatch

Uh oh!

Choose a reason for hiding this comment

Inconsistent casing in YAML placeholders

Uh oh!

Choose a reason for hiding this comment

Parent page lead-in text not updated

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Jul 27, 2026 •

edited

Loading

github-actions Bot commented Jul 27, 2026 •

edited

Loading

gtrivedi88 left a comment •

edited

Loading

Missing `[role="_additional-resources"]`

Missing `:page-aliases:` for URL redirect