feat: uds core docs #414
Merged
feat: uds core docs #414
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
Jessy-Morris
previously approved these changes
May 17, 2024
|
I think there will be some follow on iteration/restructuring as we figure out what we've got now that we've combined the docs from the two repos but I think this is a great step. |
Co-authored-by: Rob Ferguson <rjferguson21@gmail.com>
rjferguson21
approved these changes
May 17, 2024
mjnagel
pushed a commit
that referenced
this pull request
May 23, 2024
🤖 I have created a release *beep* *boop* --- ## [0.22.0](v0.21.1...v0.22.0) (2024-05-22) ### Features * add `expose` service entry for internal cluster traffic ([#356](#356)) ([1bde4cc](1bde4cc)) * add reconciliation retries for CRs ([#423](#423)) ([424b57b](424b57b)) * uds common renovate config ([#391](#391)) ([035786c](035786c)) * uds core docs ([#414](#414)) ([a35ca7b](a35ca7b)) ### Bug Fixes * mismatched exemption/policy for DropAllCapabilities ([#384](#384)) ([d8ec278](d8ec278)) * pepr mutation annotation overwrite ([#385](#385)) ([6e56b2a](6e56b2a)) * renovate config grouping, test-infra ([#411](#411)) ([05fd407](05fd407)) * renovate pepr comment ([#410](#410)) ([a825388](a825388)) ### Miscellaneous * **deps:** update keycloak ([#390](#390)) ([3e82c4e](3e82c4e)) * **deps:** update keycloak to v24.0.4 ([#397](#397)) ([c0420ea](c0420ea)) * **deps:** update keycloak to v24.0.4 ([#402](#402)) ([e454576](e454576)) * **deps:** update neuvector to v9.4 ([#381](#381)) ([20d4170](20d4170)) * **deps:** update pepr to 0.31.0 ([#360](#360)) ([fbd61ea](fbd61ea)) * **deps:** update prometheus-stack ([#348](#348)) ([49cb11a](49cb11a)) * **deps:** update prometheus-stack ([#392](#392)) ([2e656f5](2e656f5)) * **deps:** update uds to v0.10.4 ([#228](#228)) ([1750b23](1750b23)) * **deps:** update uds-k3d to v0.6.0 ([#398](#398)) ([288f009](288f009)) * **deps:** update velero ([#350](#350)) ([e7cb33e](e7cb33e)) * **deps:** update zarf to v0.33.2 ([#394](#394)) ([201a37b](201a37b)) --- 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>
rjferguson21
added a commit
that referenced
this pull request
Jul 11, 2024
## Description Integrated docs between `uds` and other repos. `uds-core` is the initial repo to be integrated. The module repo's need to add a go.mod file to their `docs` directory which is then pulled in by the `uds` repo to add the docs to the hugo site. The module repo's need to pr changes before the `uds` repo's pr can be pushed in due to failing CI runs because the main branch of the module repo's doesn't have the go.mod file present. I attempted copy and paste the doc files from `uds` with minimal changes, only changes would be links needing to reference urls instead of static local files. Hopefully the only real changes are the: * go.mod file * frontmatter addition to doc files * syntax changes for links and alert messages in docs # Will let @Jessy-Morris take the first crack at reviewing this since this is her domain! # # How to review 1. checkout the [core-docs-import](https://github.com/defenseunicorns/uds/tree/core-docs-import) branch on `uds` 2. run `npm run start` 3. open `localhost:1313` in the browser and there should be `UDS Core` tab to view the docs in this uds-core branch. ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Other (security config, docs update, etc) ## Checklist before merging - [x] Test, docs, adr added or updated as needed - [x] [Contributor Guide Steps](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md)(https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md#submitting-a-pull-request) followed --------- Co-authored-by: Rob Ferguson <rjferguson21@gmail.com>
rjferguson21
pushed a commit
that referenced
this pull request
Jul 11, 2024
🤖 I have created a release *beep* *boop* --- ## [0.22.0](v0.21.1...v0.22.0) (2024-05-22) ### Features * add `expose` service entry for internal cluster traffic ([#356](#356)) ([1bde4cc](1bde4cc)) * add reconciliation retries for CRs ([#423](#423)) ([424b57b](424b57b)) * uds common renovate config ([#391](#391)) ([035786c](035786c)) * uds core docs ([#414](#414)) ([a35ca7b](a35ca7b)) ### Bug Fixes * mismatched exemption/policy for DropAllCapabilities ([#384](#384)) ([d8ec278](d8ec278)) * pepr mutation annotation overwrite ([#385](#385)) ([6e56b2a](6e56b2a)) * renovate config grouping, test-infra ([#411](#411)) ([05fd407](05fd407)) * renovate pepr comment ([#410](#410)) ([a825388](a825388)) ### Miscellaneous * **deps:** update keycloak ([#390](#390)) ([3e82c4e](3e82c4e)) * **deps:** update keycloak to v24.0.4 ([#397](#397)) ([c0420ea](c0420ea)) * **deps:** update keycloak to v24.0.4 ([#402](#402)) ([e454576](e454576)) * **deps:** update neuvector to v9.4 ([#381](#381)) ([20d4170](20d4170)) * **deps:** update pepr to 0.31.0 ([#360](#360)) ([fbd61ea](fbd61ea)) * **deps:** update prometheus-stack ([#348](#348)) ([49cb11a](49cb11a)) * **deps:** update prometheus-stack ([#392](#392)) ([2e656f5](2e656f5)) * **deps:** update uds to v0.10.4 ([#228](#228)) ([1750b23](1750b23)) * **deps:** update uds-k3d to v0.6.0 ([#398](#398)) ([288f009](288f009)) * **deps:** update velero ([#350](#350)) ([e7cb33e](e7cb33e)) * **deps:** update zarf to v0.33.2 ([#394](#394)) ([201a37b](201a37b)) --- 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
Integrated docs between
udsand other repos.uds-coreis the initial repo to be integrated.The module repo's need to add a go.mod file to their
docsdirectory which is then pulled in by theudsrepo to add the docs to the hugo site.The module repo's need to pr changes before the
udsrepo's pr can be pushed in due to failing CI runs because the main branch of the module repo's doesn't have the go.mod file present.I attempted copy and paste the doc files from
udswith minimal changes, only changes would be links needing to reference urls instead of static local files.Hopefully the only real changes are the:
Will let @Jessy-Morris take the first crack at reviewing this since this is her domain!
How to review
udsnpm run startlocalhost:1313in the browser and there should beUDS Coretab to view the docs in this uds-core branch.Type of change
Checklist before merging