Skip to content

chore: update stale swf references#190

Open
codyshoffner wants to merge 3 commits into
mainfrom
docs/netowrking
Open

chore: update stale swf references#190
codyshoffner wants to merge 3 commits into
mainfrom
docs/netowrking

Conversation

@codyshoffner
Copy link
Copy Markdown
Contributor

@codyshoffner codyshoffner commented Apr 29, 2026

Description

SWF has been archived for awhile. Updated stale references from SWF.

Related Issue

Relates to # https://linear.app/defense-unicorns/issue/FDRY-76/uds-docs-fix-doc-references-to-old-swf-repo-common-patterns

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

Comment thread docs/configuration.md Outdated
- `postgresql.extensions`: A map of database names to lists of extensions to enable for that database (i.e. `mydb: ["postgis", "hstore"]`)
- `postgresql.version`: The version of Postgres to run (i.e. `14`)
- `postgresql.ingress`: A list of ingress entries to create for this cluster (follows the [custom networking definition](https://github.com/defenseunicorns/uds-software-factory/blob/main/docs/networking.md) except for `direction` which is always `Ingress` and `selector` which is always `cluster-name: pg-cluster`)
- `postgresql.ingress`: A list of ingress entries to create for this cluster (follows the [custom networking definition](https://github.com/uds-packages/reference-package/blob/main/chart/templates/uds-package.yaml#L48) except for `direction` which is always `Ingress` and `selector` which is always `cluster-name: pg-cluster`)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be awesome if we could reference some docs here instead. Maybe a doc from reference-package? Cross-repo line references are brittle

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we link straight to the file and not the line reference?
We talked in a meeting one day about linking to a doc, but felt that the reference package already captured the required information in it's uds-package.yaml

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Frankly, not sure, let's keep it without line right now, since you already changed it this way.

Do we (the company not the team) have any docs that describe what the package is, what's the network under it, how to define ingress? This would be the thing to link if we have this. If not, let's leave the uds-package.yaml link

@codyshoffner codyshoffner marked this pull request as ready for review April 30, 2026 17:28
@codyshoffner codyshoffner requested review from a team as code owners April 30, 2026 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants