Skip to content

Commit

Permalink
chore(docs): update Flavor Specific Development Notes (#1153)
Browse files Browse the repository at this point in the history
## 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>
  • Loading branch information
pauldipietro and UnicornChance authored Jan 6, 2025
1 parent cf1a60b commit bba5a71
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/reference/UDS Core/flavor-specific-development-notes.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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.

0 comments on commit bba5a71

Please sign in to comment.