chore(docs): update doc structure for site refresh #895
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mjnagel
reviewed
Oct 10, 2024
There was a problem hiding this comment.
Maybe a more generic structure comment now that I'm reviewing the actual diffs - the deployment and config sections are all specific to uds-core (not general "uds things"). Does it still make sense for them to be under top level "configuration" and "deployment"? Or should they be subsections under core itself?
5 tasks
mjnagel
changed the title
pauldipietro
force-pushed
the
docs-refresh-integration
branch
from
bf61793 to
3e2492b
Compare
mjnagel
reviewed
Oct 10, 2024
pauldipietro
force-pushed
the
docs-refresh-integration
branch
from
0989724 to
ca585c5
Compare
noahpb
approved these changes
Oct 11, 2024
UnicornChance
approved these changes
Oct 11, 2024
UnicornChance
pushed a commit
that referenced
this pull request
Oct 11, 2024
## Description This PR changes the docs structure to reflect the updated site architecture. - ADRs moved to a separate folder - All docs are served out of `docs/reference` (or possibly `docs/troubleshooting` if added) - Remove unnecessary front matter as needed ## 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) ## Checklist before merging - [ ] Test, docs, adr added or updated as needed - [ ] [Contributor Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md) followed --------- Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com>
UnicornChance
pushed a commit
that referenced
this pull request
Oct 11, 2024
This PR changes the docs structure to reflect the updated site architecture. - ADRs moved to a separate folder - All docs are served out of `docs/reference` (or possibly `docs/troubleshooting` if added) - Remove unnecessary front matter as needed N/A - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [X] Other (security config, docs update, etc) - [ ] Test, docs, adr added or updated as needed - [ ] [Contributor Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md) followed --------- Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com>
mjnagel
pushed a commit
that referenced
this pull request
Oct 11, 2024
🤖 I have created a release *beep* *boop* --- ## [0.29.0](v0.28.0...v0.29.0) (2024-10-11) ### Features * add base and identity layers ([#853](#853)) ([b3f532a](b3f532a)) * add logging functional layer ([#861](#861)) ([c1a67b9](c1a67b9)) * add metrics-server functional layer ([#865](#865)) ([290367a](290367a)) * add monitoring layer ([#872](#872)) ([5ecb040](5ecb040)) * add nightly testing for rke2 ([#808](#808)) ([c401419](c401419)) * add service accounts options to sso ([#852](#852)) ([1029162](1029162)) * backup and restore layer, ui layer, runtime security layer ([#862](#862)) ([b1d8015](b1d8015)) * grafana-ha ([#838](#838)) ([d532d76](d532d76)) ### Bug Fixes * broken readme link ([#899](#899)) ([6e47b11](6e47b11)) * **ci:** switch to larger runners to resolve ci disk space issues ([#882](#882)) ([1af0401](1af0401)) * snapshot ci version modification and tasks for publish ([#877](#877)) ([f01e5bd](f01e5bd)) * support for anywhere network policies in cilium ([#884](#884)) ([5df0737](5df0737)) ### Miscellaneous * cleanup license parsing for github ([#881](#881)) ([43c98ce](43c98ce)) * **deps:** update chainctl action to v0.2.3 ([#864](#864)) ([d782b59](d782b59)) * **deps:** update checkout action to v4.2.0 ([#825](#825)) ([29d1c98](29d1c98)) * **deps:** update dependency defenseunicorns/lula to v0.8.0 ([#841](#841)) ([fe36150](fe36150)) * **deps:** update githubactions ([#866](#866)) ([44f8ea5](44f8ea5)) * **deps:** update grafana to 11.2.1 ([#836](#836)) ([11383c1](11383c1)) * **deps:** update grafana to v11.2.2 ([#867](#867)) ([06ed2c3](06ed2c3)) * **deps:** update loki nginx image to v1.27.2 ([#894](#894)) ([df7d427](df7d427)) * **deps:** update loki to v3.2.0 ([#791](#791)) ([d3c60b5](d3c60b5)) * **deps:** update metrics-server chart to v3.12.2 ([#873](#873)) ([e2e61ce](e2e61ce)) * **deps:** update pepr to v0.37.1 ([#843](#843)) ([68abcb2](68abcb2)) * **deps:** update pepr to v0.37.2 ([#850](#850)) ([b51f659](b51f659)) * **deps:** update prometheus operator to 0.77.1 ([#819](#819)) ([0864b33](0864b33)) * **deps:** update prometheus-stack ([#855](#855)) ([c791c24](c791c24)) * **deps:** update prometheus-stack helm-charts to v64.0.0 ([#849](#849)) ([50a2588](50a2588)) * **deps:** update runtime to v0.6.0 ([#897](#897)) ([89ae6e2](89ae6e2)) * **deps:** update support-deps ([#890](#890)) ([26ea612](26ea612)) * **deps:** update test-infra ([#875](#875)) ([583f07c](583f07c)) * **deps:** update test-infra to v6.9.0 ([#848](#848)) ([ef9d317](ef9d317)) * **deps:** update uds to v0.17.0 ([#859](#859)) ([1489fef](1489fef)) * **deps:** update zarf to v0.41.0 ([#857](#857)) ([a390c3d](a390c3d)) * **docs:** update doc structure for site refresh ([#895](#895)) ([1946a9a](1946a9a)) * fix broken link in docs ([#845](#845)) ([3078a5b](3078a5b)) * fix license header references ([#901](#901)) ([cf38b82](cf38b82)) * handle upgrade path for functional layers, add doc for usage ([#896](#896)) ([70d6b1b](70d6b1b)) * regroup 'support dependencies' in renovate config ([#885](#885)) ([640d859](640d859)) * update license ([#878](#878)) ([b086170](b086170)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
docandrew
pushed a commit
that referenced
this pull request
Oct 17, 2024
## Description This PR changes the docs structure to reflect the updated site architecture. - ADRs moved to a separate folder - All docs are served out of `docs/reference` (or possibly `docs/troubleshooting` if added) - Remove unnecessary front matter as needed ## 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) ## Checklist before merging - [ ] Test, docs, adr added or updated as needed - [ ] [Contributor Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md) followed --------- Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com>
docandrew
pushed a commit
that referenced
this pull request
Oct 17, 2024
🤖 I have created a release *beep* *boop* --- ## [0.29.0](v0.28.0...v0.29.0) (2024-10-11) ### Features * add base and identity layers ([#853](#853)) ([b3f532a](b3f532a)) * add logging functional layer ([#861](#861)) ([c1a67b9](c1a67b9)) * add metrics-server functional layer ([#865](#865)) ([290367a](290367a)) * add monitoring layer ([#872](#872)) ([5ecb040](5ecb040)) * add nightly testing for rke2 ([#808](#808)) ([c401419](c401419)) * add service accounts options to sso ([#852](#852)) ([1029162](1029162)) * backup and restore layer, ui layer, runtime security layer ([#862](#862)) ([b1d8015](b1d8015)) * grafana-ha ([#838](#838)) ([d532d76](d532d76)) ### Bug Fixes * broken readme link ([#899](#899)) ([6e47b11](6e47b11)) * **ci:** switch to larger runners to resolve ci disk space issues ([#882](#882)) ([1af0401](1af0401)) * snapshot ci version modification and tasks for publish ([#877](#877)) ([f01e5bd](f01e5bd)) * support for anywhere network policies in cilium ([#884](#884)) ([5df0737](5df0737)) ### Miscellaneous * cleanup license parsing for github ([#881](#881)) ([43c98ce](43c98ce)) * **deps:** update chainctl action to v0.2.3 ([#864](#864)) ([d782b59](d782b59)) * **deps:** update checkout action to v4.2.0 ([#825](#825)) ([29d1c98](29d1c98)) * **deps:** update dependency defenseunicorns/lula to v0.8.0 ([#841](#841)) ([fe36150](fe36150)) * **deps:** update githubactions ([#866](#866)) ([44f8ea5](44f8ea5)) * **deps:** update grafana to 11.2.1 ([#836](#836)) ([11383c1](11383c1)) * **deps:** update grafana to v11.2.2 ([#867](#867)) ([06ed2c3](06ed2c3)) * **deps:** update loki nginx image to v1.27.2 ([#894](#894)) ([df7d427](df7d427)) * **deps:** update loki to v3.2.0 ([#791](#791)) ([d3c60b5](d3c60b5)) * **deps:** update metrics-server chart to v3.12.2 ([#873](#873)) ([e2e61ce](e2e61ce)) * **deps:** update pepr to v0.37.1 ([#843](#843)) ([68abcb2](68abcb2)) * **deps:** update pepr to v0.37.2 ([#850](#850)) ([b51f659](b51f659)) * **deps:** update prometheus operator to 0.77.1 ([#819](#819)) ([0864b33](0864b33)) * **deps:** update prometheus-stack ([#855](#855)) ([c791c24](c791c24)) * **deps:** update prometheus-stack helm-charts to v64.0.0 ([#849](#849)) ([50a2588](50a2588)) * **deps:** update runtime to v0.6.0 ([#897](#897)) ([89ae6e2](89ae6e2)) * **deps:** update support-deps ([#890](#890)) ([26ea612](26ea612)) * **deps:** update test-infra ([#875](#875)) ([583f07c](583f07c)) * **deps:** update test-infra to v6.9.0 ([#848](#848)) ([ef9d317](ef9d317)) * **deps:** update uds to v0.17.0 ([#859](#859)) ([1489fef](1489fef)) * **deps:** update zarf to v0.41.0 ([#857](#857)) ([a390c3d](a390c3d)) * **docs:** update doc structure for site refresh ([#895](#895)) ([1946a9a](1946a9a)) * fix broken link in docs ([#845](#845)) ([3078a5b](3078a5b)) * fix license header references ([#901](#901)) ([cf38b82](cf38b82)) * handle upgrade path for functional layers, add doc for usage ([#896](#896)) ([70d6b1b](70d6b1b)) * regroup 'support dependencies' in renovate config ([#885](#885)) ([640d859](640d859)) * update license ([#878](#878)) ([b086170](b086170)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR changes the docs structure to reflect the updated site architecture.
docs/reference(or possiblydocs/troubleshootingif added)Related Issue
N/A
Type of change
Checklist before merging