Merge pull request #147 from buildkite/add-composite-registry-instruc…

…tions

Add composite registry instructions to the Package Registry docs

pages/package_registries/_access_java_package_details_page.md

@@ -1,7 +1,8 @@
-A Java package's details can be accessed from this registry using the **Packages** section of your Java registry page.
+A Java package's details can be accessed from its source registry through the **Releases** (tab) section of your Java source registry page. To do this:
 
-To access your Java package's details page:
+1. Select **Package Registries** in the global navigation to access the **Registries** page.
+1. Select your Java source registry on this page.
+1. On your Java source registry page, select the package to display its details page.
 
-1. Select **Packages** in the global navigation to access the **Registries** page.
-1. Select your Java registry on this page.
-1. On your Java registry page, select the package to display its details page.
+> 📘
+> If your Java source registry is an upstream of a [composite registry](/docs/package-registries/manage-registries#composite-registries), you can also access the Java package's details from this composite registry (listed on the **Registries** page) by selecting the relevant Java composite registry > from the **Upstreams** tab, select the relevant Java source registry, then its relevant package.

pages/package_registries/_alpine_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your Alpine registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Alpine registry name, and can be obtained after accessing **Packages** in the global navigation > your Alpine registry from the **Registries** page.
+- `{registry.slug}` is the slug of your Alpine source registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of this registry's name, and can be obtained after accessing **Package Registries** in the global navigation > your Alpine source registry from the **Registries** page.

pages/package_registries/_container_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your container registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your container registry name, and can be obtained after accessing **Packages** in the global navigation > your container registry from the **Registries** page.
+- `{registry.slug}` is the slug of your container source registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of this registry's name, and can be obtained after accessing **Package Registries** in the global navigation > your container source registry from the **Registries** page.

pages/package_registries/_debian_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your Debian registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Debian registry name, and can be obtained after accessing **Packages** in the global navigation > your Debian registry from the **Registries** page.
+- `{registry.slug}` is the slug of your Debian source registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of this registry's name, and can be obtained after accessing **Package Registries** in the global navigation > your Debian source registry from the **Registries** page.

pages/package_registries/_gradle_file_configurations.md

@@ -1,3 +1,3 @@
 - Maven coordinates for your package (which you will need to manually configure yourself).
-- URL for your specific Java registry in Buildkite.
+- URL for your specific Java source registry in Buildkite.
 - API access token required to publish the package to this registry.

pages/package_registries/_helm_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your Helm registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Helm registry name, and can be obtained after accessing **Packages** in the global navigation > your Helm registry from the **Registries** page.
+- `{registry.slug}` is the slug of your Helm (OCI) source registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of this registry's name, and can be obtained after accessing **Package Registries** in the global navigation > your Helm (OCI) source registry from the **Registries** page.

pages/package_registries/_java_registry_id.md

@@ -1 +1 @@
-- `org-slug-registry-slug` is the ID of your Java registry, based on the org and Java registry slugs separated by a hyphen. The org slug can be obtained from the end of your Buildkite URL, after accessing **Packages** or **Pipelines** in the global navigation of your organization in Buildkite. The registry slug is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your registry name, and can be obtained after accessing **Packages** in the global navigation > your Java registry from the **Registries** page. The Java registry ID can actually be any valid unique value, as long as the same value is used in both your `settings.xml` and `pom.xml` files.
+- `org-slug-registry-slug` is the ID of your Java source registry, based on the org and this registry's slugs separated by a hyphen. The org slug can be obtained from the end of your Buildkite URL, after accessing **Package Registries** or **Pipelines** in the global navigation of your organization in Buildkite. The registry slug is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your registry name, and can be obtained after accessing **Package Registries** in the global navigation > your Java source registry from the **Registries** page. The Java source registry ID can actually be any valid unique value, as long as the same value is used in both your `settings.xml` and `pom.xml` files.

pages/package_registries/_java_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your Java registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Java registry name, and can be obtained after accessing **Packages** in the global navigation > your Java registry from the **Registries** page.
+- `{registry.slug}` is the slug of your Java source registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of this registry's name, and can be obtained after accessing **Package Registries** in the global navigation > your Java source registry from the **Registries** page.

pages/package_registries/_java_registry_write_token.md

@@ -1 +1 @@
-- `registry-write-token` is your [API access token](https://buildkite.com/user/api-access-tokens) used to publish/upload packages to your Java registry. Ensure this access token has the **Write Packages** REST API scope, which allows this token to publish packages to any registry your user account has access to within your Buildkite organization.
+- `registry-write-token` is your [API access token](https://buildkite.com/user/api-access-tokens) used to publish/upload packages to your Java source registry. Ensure this access token has the **Read Packages** and **Write Packages** REST API scopes, which allows this token to publish packages to any source registry your user account has access to within your Buildkite organization.

pages/package_registries/_javascript_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your JavaScript registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your JavaScript registry name, and can be obtained after accessing **Packages** in the global navigation > your JavaScript registry from the **Registries** page.
+- `{registry.slug}` is the slug of your JavaScript source registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of this registry's name, and can be obtained after accessing **Package Registries** in the global navigation > your JavaScript source registry from the **Registries** page.

pages/package_registries/_javascript_registry_write_token.md

@@ -1 +1 @@
-- `registry-write-token` is your [API access token](https://buildkite.com/user/api-access-tokens) used to publish/upload packages to your JavaScript registry. Ensure this access token has the **Write Packages** REST API scope, which allows this token to publish packages to any registry your user account has access to within your Buildkite organization.
+- `registry-write-token` is your [API access token](https://buildkite.com/user/api-access-tokens) used to publish/upload packages to your JavaScript source registry. Ensure this access token has the **Read Packages** and **Write Packages** REST API scopes, which allows this token to publish packages to any source registry your user account has access to within your Buildkite organization.

pages/package_registries/_org_slug.md

@@ -1 +1 @@
-- `{org.slug}` can be obtained from the end of your Buildkite URL, after accessing **Packages** or **Pipelines** in the global navigation of your organization in Buildkite.
+- `{org.slug}` can be obtained from the end of your Buildkite URL, after accessing **Package Registries** or **Pipelines** in the global navigation of your organization in Buildkite.

pages/package_registries/_package_details_page_sections.md

@@ -8,12 +8,12 @@ The package's details page provides the following information in the following s
 
     * the name of the package (typically the file name excluding any version details and extension).
     * the package version.
-    * the registry the package is located in.
+    * the source registry the package is located in.
     * the package's visibility (based on its registry's visibility)—whether the package is **Private** and requires authentication to access, or is publicly accessible.
     * the distribution name / version.
     * additional optional metadata contained within the package, such as a homepage, licenses, etc.
 
-- **Pushed**: the date when the last package was uploaded to the registry.
+- **Pushed**: the date when the last package was uploaded to the source registry.
 - **Total files**: the total number of files (and directories) within the package.
 - **Dependencies**: the number of dependency packages required by this package.
 - **Package size**: the storage size (in bytes) of this package.

pages/package_registries/_python_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your Python registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Python registry name, and can be obtained after accessing **Packages** in the global navigation > your Python registry from the **Registries** page.
+- `{registry.slug}` is the slug of your Python source registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of this registry's name, and can be obtained after accessing **Package Registries** in the global navigation > your Python source registry from the **Registries** page.

pages/package_registries/_red_hat_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your Red Hat registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Red Hat registry name, and can be obtained after accessing **Packages** in the global navigation > your Red Hat registry from the **Registries** page.
+- `{registry.slug}` is the slug of your Red Hat registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Red Hat registry name, and can be obtained after accessing **Package Registries** in the global navigation > your Red Hat registry from the **Registries** page.

pages/package_registries/_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your registry name, and can be obtained after accessing **Packages** in the global navigation > your registry from the **Registries** page.
+- `{registry.slug}` is the slug of your registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your registry name, and can be obtained after accessing **Package Registries** in the global navigation > your registry from the **Registries** page.

pages/package_registries/_ruby_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your Ruby registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Ruby registry name, and can be obtained after accessing **Packages** in the global navigation > your Ruby registry from the **Registries** page.
+- `{registry.slug}` is the slug of your Ruby registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Ruby registry name, and can be obtained after accessing **Package Registries** in the global navigation > your Ruby registry from the **Registries** page.

pages/package_registries/_ruby_registry_write_token.md

@@ -1 +1 @@
-- `registry-write-token` is your [API access token](https://buildkite.com/user/api-access-tokens) used to publish/upload packages to your Ruby registry. Ensure this access token has the **Write Packages** REST API scope, which allows this token to publish packages to any registry your user account has access to within your Buildkite organization.
+- `registry-write-token` is your [API access token](https://buildkite.com/user/api-access-tokens) used to publish/upload packages to your Ruby registry. Ensure this access token has the **Read Packages** and **Write Packages** REST API scopes, which allows this token to publish packages to any registry your user account has access to within your Buildkite organization.

pages/package_registries/_terraform_registry_slug.md

@@ -1 +1 @@
-- `{registry.slug}` is the slug of your Terraform registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Terraform registry name, and can be obtained after accessing **Packages** in the global navigation > your Terraform registry from the **Registries** page.
+- `{registry.slug}` is the slug of your Terraform registry, which is the [kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of your Terraform registry name, and can be obtained after accessing **Package Registries** in the global navigation > your Terraform registry from the **Registries** page.

pages/package_registries/_updatable_registry_components_1.md

@@ -0,0 +1,4 @@
+- **Name**: be aware that changing this value will also change the URL, which in turn will break any existing installations that use this registry.
+- **Description**
+- **Emoji**: to change the emoji of the registry from the default provided when the [source](#create-a-source-registry) or [composite](#composite-registries-create-a-composite-registry) registry was created. The emoji appears next to the registry's name.
+- **Color**: the background color for the emoji

pages/package_registries/_updatable_registry_components_2.md

@@ -0,0 +1 @@
+- **Tokens** (private registries only): one or more [registry tokens](#configure-registry-tokens), which are an alternative to API access tokens.