Skip to content

Commit 91e0385

Browse files
committed
Harmonize how we reference UI labels and navigation paths
1 parent 87985d0 commit 91e0385

14 files changed

+78
-62
lines changed

CLAUDE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Documentation Guidelines
2+
3+
## UI Label Formatting
4+
5+
Use _italics_ for UI labels and navigation paths:
6+
- Format: `_Settings > Manage Credentials_`
7+
- Separator: `>` (not `->`)
8+
- Examples: `_Add Package > By Url_`, `_Mirroring_`, `_Authentication Tokens_`
9+
10+
Don't use backticks for UI labels - backticks are for code/commands only.
11+
12+
## Links
13+
14+
Do NOT include `.md` file extensions in links:
15+
-`[Guide](mirror-magento-marketplace)`
16+
-`[Guide](mirror-magento-marketplace.md)`

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Alternatively you can copy the SSH public key for your organization on the same
1313

1414
### Add packages
1515

16-
If your organization is synchronized Private Packagist will have created packages for all of your private repositories containing a composer.json. Otherwise or if you would like to add additional packages you can add them in the _Packages_ section of your organization with the Add button. Follow the instructions to pick the right option for your package.
16+
If your organization is synchronized Private Packagist will have created packages for all of your private repositories containing a composer.json. Otherwise or if you would like to add additional packages you can add them in the _Packages_ section of your organization with the _Add_ button. Follow the instructions to pick the right option for your package.
1717

1818
### Configure your project to use Private Packagist
1919

docs/centralized-authentication-and-sso.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,21 @@ you can skip this step. Otherwise, the first step is making sure your users can
2727
OAuth authentication with the cloud versions of the default code hosting platforms (github.com, bitbucket.org and gitlab.com) is
2828
preconfigured on Private Packagist Cloud, but not on Private Packagist Self-Hosted.
2929

30-
Go to _Settings > Integrations_ and press the "Add Integration" button.
30+
Go to _Settings > Integrations_ and press the _Add Integration_ button.
3131

3232
![Create an integration](/Resources/public/img/docs/articles/centralized-authentication-and-sso/configure-integration.png)
3333

3434
### 2 - Connect your account via OAuth
3535

36-
Go to your [profile](/profile) and find the _Connected Accounts_ section. Click on the "Connect" button to go through the OAuth authentication
36+
Go to your [profile](/profile) and find the _Connected Accounts_ section. Click on the _Connect_ button to go through the OAuth authentication
3737
flow, and associate your Private Packagist account with your GitHub, GitLab or Bitbucket account.
3838

3939
![Connect your account via OAuth](/Resources/public/img/docs/articles/centralized-authentication-and-sso/profile-connect.png)
4040

4141
### 3 - Set up the synchronization
4242

43-
Now we can continue to set up the synchronization. In your organization, go to _Settings > Synchronizations_ and press the
44-
"Add Synchronization" button. Follow the steps to complete the configuration.
43+
Now we can continue to set up the synchronization. In your organization, go to _Settings > Synchronizations_ and press the
44+
_Add Synchronization_ button. Follow the steps to complete the configuration.
4545

4646
![Create a synchronization](/Resources/public/img/docs/articles/centralized-authentication-and-sso/configure-synchronization.png)
4747

@@ -52,9 +52,9 @@ once they log in via OAuth. Only users who have logged into Private Packagist us
5252
Whether or not you are using automatic user provisioning, Private Packagist will always manage the same users as those provisioned
5353
in your code hosting platform. If a user is removed, that same user will also be removed from Private Packagist.
5454

55-
If you want to control which of your users should be allowed to access Private Packagist at all, you can opt to deactivate
56-
users discovered by the synchronization by default. Then, only users that you activate manually will be able to log in.
57-
To enable this behavior, go to the _Teams_ tab, and click on "View and manage all members of this organization" and check the box:
55+
If you want to control which of your users should be allowed to access Private Packagist at all, you can opt to deactivate
56+
users discovered by the synchronization by default. Then, only users that you activate manually will be able to log in.
57+
To enable this behavior, go to the _Teams_ tab, and click on _View and manage all members of this organization_ and check the box:
5858

5959
![Deactivate users discovered by synchronization](/Resources/public/img/docs/articles/centralized-authentication-and-sso/deactivate-sync-members.png)
6060

@@ -64,20 +64,20 @@ Now we can enforce OAuth authentication for all users in the organization, to en
6464
identity system configured on the code hosting platform in order to access Private Packagist and cannot use an alternative
6565
method to log into Private Packagist.
6666

67-
Go to _Settings > Access_ and apply the changes. From now on, everyone - including yourself - will be required to
67+
Go to _Settings > Access_ and apply the changes. From now on, everyone - including yourself - will be required to
6868
authenticate via your configured integration.
6969

7070
![Enforce OAuth authentication](/Resources/public/img/docs/articles/centralized-authentication-and-sso/enforce-oauth.png)
7171

7272
### 5 - Share the organization-specific login link
7373

74-
If you set up your own integration in Step 1, the final step is sharing your organization-specific login link with your users.
75-
Look for the "Login link" button in _Settings > Integrations_ page.
74+
If you set up your own integration in Step 1, the final step is sharing your organization-specific login link with your users.
75+
Look for the _Login link_ button in _Settings > Integrations_ page.
7676

7777
![Login link settings](/Resources/public/img/docs/articles/centralized-authentication-and-sso/login-link-settings.png)
7878

7979
This link presents the option to authenticate with your configured integration. Once the user clicks on the
80-
"Log in with <integration name>" button, the authentication process is initiated and your users are redirected to your
80+
_Log in with <integration name>_ button, the authentication process is initiated and your users are redirected to your
8181
code-hosting platform to log in.
8282

8383
![Login link example](/Resources/public/img/docs/articles/centralized-authentication-and-sso/login-link-example.png)

docs/cloud/bitbucket-server-oauth1-integration-setup.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ To allow your users to authenticate to Private Packagist with their Bitbucket Da
2626
first need to create an integration in Private Packagist. This document walks you through the required steps.
2727

2828
## Open the Add Integration form
29-
From the organization settings page, select the "Integrations" subtab.
30-
Hit the "Add Integration" button on the integrations listing page to get to the form below.
29+
From the organization settings page, select the *Integrations* subtab.
30+
Hit the *Add Integration* button on the integrations listing page to get to the form below.
3131
To set up a Bitbucket Data Center / Server integration with Private Packagist, start by selecting "Bitbucket Data Center / Server"
3232
as the platform, enter the URL of your on-premise Bitbucket Data Center / Server into the base URL field and select OAuth 1 as the OAuth version as seen in the example below.
3333

@@ -38,17 +38,17 @@ Submit the form to see the additional information.
3838
![Packagist Form](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-oauth1-02-packagist-details-20250103.png)
3939

4040
## Configure Application link
41-
Click on the link to setup an Application Link on Bitbucket Data Center / Server. You will need the "Client Id" and the "Public Key" shown in the form.
41+
Click on the link to setup an Application Link on Bitbucket Data Center / Server. You will need the *Client Id* and the *Public Key* shown in the form.
4242

4343
![Bitbucket Data Center / Server Configure Application Link](/Resources/public/img/docs/integration-setup/bitbucket-server-oauth1-03-bitbucket-configure-application-link.png)
4444

4545
For Bitbucket Data Center versions 7.21 and newer, select "Atlassian product" and not "External application" to be able to set up an OAuth1 link.
4646

47-
After you hit the button to create a new Application Link a configuration window may appear. If it does, verify that the url matches the "Application URL for Link" (_https://packagist.com_) and hit "Continue", otherwise skip this step.
47+
After you hit the button to create a new Application Link a configuration window may appear. If it does, verify that the url matches the *Application URL for Link* (_https://packagist.com_) and hit *Continue*, otherwise skip this step.
4848

4949
![Bitbucket Data Center / Server Invalid Url](/Resources/public/img/docs/integration-setup/bitbucket-server-oauth1-04-bitbucket-invalid-url.png)
5050

51-
Now setup a "Generic Application". The only field required is the "Application Name". Submit the form to finish creating the Application Link.
51+
Now setup a *Generic Application*. The only field required is the *Application Name*. Submit the form to finish creating the Application Link.
5252

5353
![Bitbucket Data Center / Server Setup Link](/Resources/public/img/docs/integration-setup/bitbucket-server-oauth1-05-bitbucket-setup-link.png)
5454

@@ -58,12 +58,12 @@ Click on the pen icon to the right of the application you just created to edit t
5858

5959
![Bitbucket Data Center / Server Incoming Auth](/Resources/public/img/docs/integration-setup/bitbucket-server-oauth1-07-bitbucket-incoming-auth.png)
6060

61-
This is where we will need the "Client ID" and the "Public Key" that were previously generated on the Private Packagist integration form.
62-
Enter the "Client ID" into the "Consumer Key" field, make sure the entire content of the "Public Key" field gets copied and the "Consumer Callback" field stays empty.
61+
This is where we will need the *Client ID* and the *Public Key* that were previously generated on the Private Packagist integration form.
62+
Enter the *Client ID* into the *Consumer Key* field, make sure the entire content of the *Public Key* field gets copied and the *Consumer Callback* field stays empty.
6363
Submit the form and go back to the list of integrations in Private Packagist.
6464

6565
### Share the Bitbucket login link
66-
The final step is sharing your organization-specific login link with your users. Look for the "Login link" button next to
66+
The final step is sharing your organization-specific login link with your users. Look for the *Login link* button next to
6767
your newly created Bitbucket Data Center / Server integration on the integrations page, and copy the URL.
6868

6969
![Bitbucket Data Center / Server integrations](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-oauth1-08-integrations-overview.png)

docs/dependabot-for-private-packagist.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This guide explains how to configure and set up Dependabot if you want to use it
88

99
## Enable Dependabot in GitHub
1010

11-
Start in your GitHub repository and go to Settings. In the Security section of the sidebar go to Code security and analysis, where you can enable Dependabot. In this process, you will create a dependabot.yaml [as shown as below](#dependabotyaml). Follow [this guide on GitHub](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide#enabling-dependabot-for-your-repository) for the complete steps to enable Dependabot.
11+
Start in your GitHub repository and go to *Settings*. In the *Security* section of the sidebar go to *Code security and analysis*, where you can enable Dependabot. In this process, you will create a dependabot.yaml [as shown as below](#dependabotyaml). Follow [this guide on GitHub](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide#enabling-dependabot-for-your-repository) for the complete steps to enable Dependabot.
1212

1313
![enable dependabot](/Resources/public/img/docs/articles/dependabot-secret.png)
1414

@@ -37,19 +37,19 @@ registries:
3737
3838
Replace the Composer URL `https://repo.packagist.com/acme/` with your organization's Composer URL on packagist.com. The example URL is for the organization named `acme`.
3939

40-
To grant Dependabot access to the packages on Private Packagist, you need to provide the secret `PRIVATE_PACKAGIST_AUTH_TOKEN` to your GitHub repository. In Settings, under the section Security,” there is a Secrets and Variables page for Dependabot.
40+
To grant Dependabot access to the packages on Private Packagist, you need to provide the secret `PRIVATE_PACKAGIST_AUTH_TOKEN` to your GitHub repository. In *Settings*, under the section *Security*, there is a *Secrets and Variables* page for Dependabot.
4141

4242
![Dependabot Secrets](/Resources/public/img/docs/articles/dependabot-secret.png)
4343

44-
Now, on Private Packagist, create an authentication token with update access under Settings and Authentication Tokens. Copy the secret token into the GitHub form.
44+
Now, on Private Packagist, create an authentication token with update access under *Settings* and *Authentication Tokens*. Copy the secret token into the GitHub form.
4545

4646
## Troubleshooting
4747

48-
To check if Dependabot is able to access your packages, navigate to Insights on your GitHub repository, then Dependency Graph and then activate the tab Dependabot.
48+
To check if Dependabot is able to access your packages, navigate to *Insights* on your GitHub repository, then *Dependency Graph* and then activate the tab *Dependabot*.
4949

5050
![Dependabot Insights](/Resources/public/img/docs/articles/dependabot-insights.png)
5151

52-
There is a link Recent update jobs, that will show the last jobs from Dependabot and logs. The last job should be green now.
52+
There is a link *Recent update jobs*, that will show the last jobs from Dependabot and logs. The last job should be green now.
5353

5454
![Dependabot Jobs](/Resources/public/img/docs/articles/dependabot-jobs.png)
5555

docs/mirror-magento-marketplace.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,34 +5,34 @@ Private Packagist supports mirroring Composer repositories which require authent
55

66
Mirrored packages show up in your Private Packagist search results, your [License Review](../features/license-review.d), and can be installed from your Private Packagist repository with Composer. Their distribution files are cached in your Private Packagist organization to make downloads redundant and faster.
77

8-
To setup credentials for a repository, Magento Marketplace in our example, head to Settings > Manage Credentials in your Private Packagist organization. Afterwards you can add a new mirrored third party repository under Settings as well. From then on packages can be manually or automatically mirrored based on your configuration.
8+
To setup credentials for a repository, "Magento Marketplace" in our example, head to *Settings > Manage Credentials* in your Private Packagist organization. Afterwards you can add a new mirrored third party repository under *Settings* as well. From then on packages can be manually or automatically mirrored based on your configuration.
99

1010
## Magento Marketplace Walkthrough
11-
Start by hitting Manage Credentials in your organizations settings. My organization is called ACME Company.
11+
Start by hitting *Manage Credentials* in your organizations settings. My organization is called "ACME Company".
1212

1313
![Manage Credentials](/Resources/public/img/docs/features/magento/Magento-Credentials-20200723.png)
1414

15-
Next enter a description, Im going with Magento Marketplace Credentials, and select Magento Marketplace as the authentication type. The domain repo.magento.com will be filled in automatically. Now we need the Magento Marketplace Public and Private Key, well click on My Access Keys to get to the Magento Marketplace website.
15+
Next enter a description, I'm going with "Magento Marketplace Credentials", and select "Magento Marketplace" as the authentication type. The domain "repo.magento.com" will be filled in automatically. Now we need the Magento Marketplace Public and Private Key, we'll click on *My Access Keys* to get to the Magento Marketplace website.
1616

1717
![Create Credentials](/Resources/public/img/docs/features/magento/Magento-Credentials-Edit-20200723.png)
1818

19-
Make sure youre on the Magento 2 Access Keys page, and then copy and paste the Private and Public keys into the respective fields on Private Packagist. Once youre done, hit Create on the Private Packagist Credentials page.
19+
Make sure you're on the Magento 2 Access Keys page, and then copy and paste the Private and Public keys into the respective fields on Private Packagist. Once you're done, hit *Create* on the Private Packagist Credentials page.
2020

2121
![Magento Access Keys](/Resources/public/img/docs/features/magento/Magento-Access-Keys.png)
2222

23-
With the credentials set up we can now mirror a new Composer repository under Settings in the Private Packagist organization.
23+
With the credentials set up we can now mirror a new Composer repository under *Settings* in the Private Packagist organization.
2424

2525
![Mirror Settings](/Resources/public/img/docs/features/magento/Magento-Settings-Mirror-20200723.png)
2626

2727
Pick a name for the repository, I picked “Magento Marketplace”, enter the URL “https://repo.magento.com” and pick the credentials we just set up for authentication with this repository. You can choose whether you would like packages to be mirrored automatically when someone tries to access them through composer update, or if you would like to add them yourself manually.
2828

2929
![Mirror Add](/Resources/public/img/docs/features/magento/Magento-Mirror-Add-20200723.png)
3030

31-
Under Packages we can now add a package From Mirror.
31+
Under Packages we can now add a package *From Mirror*.
3232

3333
![Packages Add](/Resources/public/img/docs/features/magento/Magento-Packages-Add-2020723.png)
3434

35-
Im going to enter just one package for the demo, but you can add as many as you like here. Im going with magento/module-catalog. Make sure to select the Magento Marketplace Mirror repository underneath, and hit Add.
35+
I'm going to enter just one package for the demo, but you can add as many as you like here. I'm going with "magento/module-catalog". Make sure to select the "Magento Marketplace" Mirror repository underneath, and hit *Add*.
3636

3737
![Packages Add Proxied](/Resources/public/img/docs/features/magento/Magento-Add-Mirrored-20200723.png)
3838

docs/self-hosted/authentication-email-addresses-passwords-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Setup
55
By default, authentication with email addresses and passwords is disabled. If possible, we recommend setting up authentication with your installation of [GitHub (Enterprise)](./github-integration-setup.md), [Bitbucket.org](./bitbucket-integration-setup.md), [Bitbucket Data Center / Server](./bitbucket-server-integration-setup.md), or [GitLab](./gitlab-integration-setup.md) using OAuth instead.
66

7-
Navigate to the "Global Configuration" section from the admin page to get to the form below.
8-
Enable login and account registration with email addresses and passwords by selecting the option in the form and submitting the form via the "Update configuration" button.
7+
Navigate to the *Global Configuration* section from the admin page to get to the form below.
8+
Enable login and account registration with email addresses and passwords by selecting the option in the form and submitting the form via the *Update configuration* button.
99

1010
![Packagist Setup](/Resources/public/img/docs/integration-setup/self-hosted/login-password-01-packagist-setup-20250103.png)

0 commit comments

Comments
 (0)