From bba5a710f1b9f8bf92039f00a382a28578846727 Mon Sep 17 00:00:00 2001 From: Paul Di Pietro Date: Mon, 6 Jan 2025 13:13:56 -0500 Subject: [PATCH] chore(docs): update Flavor Specific Development Notes (#1153) ## Description Update the text for the Flavor Specific Development Notes to remove public callouts. (Also add a description to the page frontmatter) ## Related Issue N/A ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [X] Other (security config, docs update, etc) ## Steps to Validate N/A ## Checklist before merging - [X] Test, docs, adr added or updated as needed - [X] [Contributor Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md) followed Co-authored-by: Chance <139784371+UnicornChance@users.noreply.github.com> --- .../reference/UDS Core/flavor-specific-development-notes.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/reference/UDS Core/flavor-specific-development-notes.md b/docs/reference/UDS Core/flavor-specific-development-notes.md index 7a576c5b8..c1027dcd4 100644 --- a/docs/reference/UDS Core/flavor-specific-development-notes.md +++ b/docs/reference/UDS Core/flavor-specific-development-notes.md @@ -1,5 +1,6 @@ --- title: Flavor Specific Development Notes +description: This document describes various flavors of UDS Core. --- Specific flavors of UDS Core have access and architecture restrictions when used for development work. The `upstream` flavor is generally recommended for development as it does not have any restrictions or requirements. @@ -12,6 +13,7 @@ Images in `registry1` historically only supported `amd64` architectures. While s ### Unicorn -The `unicorn` flavor uses images primarily from a private Chainguard repository. These images can be pulled by any developers in the Defense Unicorns organization once added to the Chainguard repository. Local authentication should be done with [chainctl](https://edu.chainguard.dev/chainguard/administration/how-to-install-chainctl/), specifically using the [credential helper](https://edu.chainguard.dev/chainguard/administration/how-to-install-chainctl/#configure-a-docker-credential-helper) for a seamless experience. -Developers outside of the Defense Unicorns organization/company will be unable to pull these images directly and should rely on CI testing for validation of this flavor. [Contact us](https://www.defenseunicorns.com/contactus) if you have a need to pull these images and develop on this flavor in particular. +The `unicorn` flavor uses images primarily from a private repository. These images can be pulled by any developer in the Defense Unicorns organization. + +Developers outside the Defense Unicorns organization/company will be unable to pull these images directly and should rely on CI testing for validation of this flavor. [Contact us](https://www.defenseunicorns.com/contactus) if you have a need to pull these images and develop on this flavor in particular.