Skip to content

Commit ee52a2f

Browse files
authored
Docs: Replace navigation instructions with direct URLs w/ organization chooser (#10457)
* Replace navigation instructions with direct URLs w/ organization chooser * Quickly fix some words and sentences
1 parent 7667580 commit ee52a2f

5 files changed

+28
-27
lines changed

docs/user/commercial/subscriptions.rst

+2-5
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,8 @@ You can always find our most up to date pricing information on our `pricing page
1515
Managing your subscription
1616
--------------------------
1717

18-
* Go to https://readthedocs.com/organizations/.
19-
* Select your organization from this list.
20-
* Select :guilabel:`Settings` at the top of the page.
21-
* Select the :guilabel:`Subscription` tab on the left.
22-
* Click :guilabel:`Manage Subscription`.
18+
1. Navigate to the `subscription management page <https://readthedocs.com/organizations/choose/subscription_detail/>`__.
19+
2. Click :guilabel:`Manage Subscription`.
2320

2421
This action will take you to the Stripe billing portal where you can manage your subscription.
2522

docs/user/guides/manage-read-the-docs-teams.rst

+13-8
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,25 @@ Adding a user to a team
1313

1414
Adding a user to a team gives them all the permissions available to that team,
1515
whether it's *read-only* or *admin*.
16-
This can be done by:
1716

18-
* Navigating to :guilabel:`<Username dropdown>` > :guilabel:`Organizations` > :guilabel:`<Organization name>` > :guilabel:`Teams` > :guilabel:`<Team name>`
19-
* Clicking :guilabel:`Invite Member`.
20-
* Input the user's Read the Docs username or email address.
21-
* Clicking :guilabel:`Add member`.
17+
Follow these steps:
18+
19+
1. Navigate to the `teams management page <https://readthedocs.com/organizations/choose/organization_team_list/>`__.
20+
2. Click on a :guilabel:`<team name>`.
21+
3. Click :guilabel:`Invite Member`.
22+
4. Input the user's Read the Docs username or email address.
23+
5. Click :guilabel:`Add member`.
2224

2325
Removing a user from a team
2426
----------------------------
2527

26-
Removing a user from a team removes all permissions that team gave them
28+
Removing a user from a team removes all permissions that team gave them.
29+
30+
Follow these steps:
2731

28-
* Navigating to :guilabel:`<Username dropdown>` > :guilabel:`Organizations` > :guilabel:`<Organization name>` > :guilabel:`Teams` > :guilabel:`<Team name>`
29-
* Clicking :guilabel:`Remove` next to the user.
32+
1. Navigate to the `teams management page <https://readthedocs.com/organizations/choose/organization_team_list/>`__.
33+
2. Click on :guilabel:`<team name>`.
34+
3. Click :guilabel:`Remove` next to the user.
3035

3136

3237
Grant access to users to import a project

docs/user/guides/setup-single-sign-on-github-gitlab-bitbucket.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Enabling SSO
2727

2828
You can enable this feature in your organization by:
2929

30-
* Navigate to :guilabel:`<Username dropdown>` > :guilabel:`Organizations` > :guilabel:`<Organization name>` > :guilabel:`Settings` > :guilabel:`Authorization`
31-
* Select :guilabel:`GitHub, GitLab or Bitbucket` on the :guilabel:`Provider` dropdown.
32-
* Select :guilabel:`Save`
30+
1. Navigate to the `authorization setting page <https://readthedocs.com/organizations/choose/organization_sso/>`__.
31+
2. Select :guilabel:`GitHub, GitLab or Bitbucket` on the :guilabel:`Provider` dropdown.
32+
3. Select :guilabel:`Save`
3333

3434
.. warning::
3535
Once you enable this option,

docs/user/guides/setup-single-sign-on-google-email.rst

+8-9
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,21 @@ Enabling SSO
3030
By default, users that sign up with a Google account do not have any permissions over any project.
3131
However, you can define which teams users matching your company's domain email address will auto-join when they sign up.
3232

33-
You can enable this feature in your organization:
34-
35-
* Navigate to :menuselection:`<Username dropdown> > Organizations --> <Organization Name> --> Settings --> Authorization`
36-
* Select **Google** in the :guilabel:`Provider` drop-down.
37-
* Specify your Google Workspace domain in the :guilabel:`Domain` input field and press :guilabel:`Save`.
33+
1. Navigate to the `authorization setting page <https://readthedocs.com/organizations/choose/organization_sso/>`__.
34+
2. Select **Google** in the :guilabel:`Provider` drop-down.
35+
3. Specify your Google Workspace domain in the :guilabel:`Domain` input field and press :guilabel:`Save`.
3836

3937
Configure team for all users to join
4038
------------------------------------
4139

4240
You can mark one or many teams that users are automatically joined when they sign up with a matching email address.
4341
Configure this option by:
4442

45-
* Navigating to :guilabel:`<Username dropdown>` > :guilabel:`Organizations` > :guilabel:`<Organization name>` > :guilabel:`Teams` > :guilabel:`<Team name>`
46-
* Click :guilabel:`Edit team`
47-
* Enable *Auto join users with an organization's email address to this team*.
48-
* Click :guilabel:`Save`
43+
1. Navigate to the `teams management page <https://readthedocs.com/organizations/choose/organization_team_list/>`__.
44+
2. Click the :guilabel:`<team name>`.
45+
3. Click :guilabel:`Edit team`
46+
4. Enable *Auto join users with an organization's email address to this team*.
47+
5. Click :guilabel:`Save`
4948

5049
With this enabled,
5150
all users that sign up with their ``[email protected]`` email will automatically join this team.

docs/user/shared/organization-permissions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ you need to be an *owner* of that organization.
66

77
You can validate your ownership of the Organization with these steps:
88

9-
* Navigate to :guilabel:`<Username dropdown>` > :guilabel:`Organizations` > :guilabel:`<Organization name>`
10-
* Look at the :guilabel:`Owners` section on the right menu.
9+
1. Navigate to the `organization management page <https://readthedocs.com/organizations/choose/organization_detail/>`__.
10+
2. Look at the :guilabel:`Owners` section on the right menu.
1111

1212
If you'd like to modify this setting and are not an owner,
1313
you can ask an existing organization owner to take the actions listed.

0 commit comments

Comments
 (0)