chore(docs): initial-ssp-generate-doc #548
Merged
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
|
For posterity - discussed splitting the content into |
brandtkeller
requested changes
Jul 25, 2024
There was a problem hiding this comment.
Would like to generalize some of the content to remove mention of topics that still have a large amount of discovery to perform.
These docs will go live on our docs site upon renovate merge to the lula-docs repo - we should be explicit in defining the generation document as proposed work and not yet implemented.
meganwolf0
previously approved these changes
Aug 9, 2024
brandtkeller
reviewed
Aug 9, 2024
brandtkeller
changed the title
brandtkeller
approved these changes
Aug 9, 2024
This was referenced Aug 9, 2024
meganwolf0
pushed a commit
that referenced
this pull request
Aug 19, 2024
* feat: initial-ssp-generate-doc * updated some wording * split ssp docs, updated some assessment result spellings. * ssp doc updates * broke assessment results at somepoint * updated note location * chore(docs): minor adjustments to intent and terms * chore(docs): cleanup testing artifacts * chore(docs): fix typos and add to dict --------- Co-authored-by: Brandt Keller <brandt.keller@defenseunicorns.com> Co-authored-by: Brandt Keller <43887158+brandtkeller@users.noreply.github.com>
brandtkeller
added a commit
that referenced
this pull request
Aug 30, 2024
* feat!(tui): initial commit * chore(deps): update actions/upload-artifact action to v4.3.6 (#575) | datasource | package | from | to | | ----------- | ----------------------- | ------ | ------ | | github-tags | actions/upload-artifact | v4.3.4 | v4.3.6 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update module github.com/open-policy-agent/opa to v0.67.1 (#577) | datasource | package | from | to | | ---------- | -------------------------------- | ------- | ------- | | go | github.com/open-policy-agent/opa | v0.67.0 | v0.67.1 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Megan Wolf <97549300+meganwolf0@users.noreply.github.com> * chore(deps): update github/codeql-action action to v3.26.0 (#582) | datasource | package | from | to | | ----------- | -------------------- | -------- | ------- | | github-tags | github/codeql-action | v3.25.15 | v3.26.0 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(generate): proposed transition of generation annotation to props (#574) * fix(generate): generation annotation in a prop * fix(generate): introduce framework flag to generate * chore(docs): add generation ns docs * feat(validation-result)!: bump to go-oscal v0.6.0 jsonschema v6 update (#544) * feat(validation-result)!: remove validation-result in favor of new go-oscal behavior chore(go-oscal): update w/ go-oscal jsonschema v6 changes * docs(reference): update jsonschema url, run go mod tidy to remove lingering jsonschemav5 inderect dep * test: update w/ current branch sha from go-oscal * chore(deps): bump go-oscal to v0.6.0 * fix(unit): cleanup whitespaces for composed artifact --------- Co-authored-by: Brandt Keller <brandt.keller@defenseunicorns.com> * fix(validate): get non-namespace scoped resources (#585) * fix(validate): get non-namespace scoped resources * fix(validate): alternate cluster-scoped resource get, schema mods * fix: updated conditional statement * docs: updated k8s domain doc * chore(deps): update dependency commitlint to v19.4.0 (#583) | datasource | package | from | to | | ---------- | ---------- | ------ | ------ | | npm | commitlint | 19.3.0 | 19.4.0 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(docs): initial SSP generation research docs (#548) * feat: initial-ssp-generate-doc * updated some wording * split ssp docs, updated some assessment result spellings. * ssp doc updates * broke assessment results at somepoint * updated note location * chore(docs): minor adjustments to intent and terms * chore(docs): cleanup testing artifacts * chore(docs): fix typos and add to dict --------- Co-authored-by: Brandt Keller <brandt.keller@defenseunicorns.com> Co-authored-by: Brandt Keller <43887158+brandtkeller@users.noreply.github.com> * chore(main): release 0.5.0 (#578) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * chore(docs): update issue template with expected deliverables line item (#590) * chore(deps): update anchore/sbom-action action to v0.17.1 (#593) | datasource | package | from | to | | ----------- | ------------------- | ------- | ------- | | github-tags | anchore/sbom-action | v0.17.0 | v0.17.1 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update github/codeql-action action to v3.26.1 (#595) | datasource | package | from | to | | ----------- | -------------------- | ------- | ------- | | github-tags | github/codeql-action | v3.26.0 | v3.26.1 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(docs): updated namespace doc locations and associated prop namespace url (#602) * fix: updated ns docs, ns prop * fix: remove test file feat: more tui design feat: more tui design feat: more tui design feat: more tui design * fix: removed debug bin * fix: removed rest files * fix: removed rest files * fix: fixed test expectations * feat: tui sizing, fixes * feat: updated keybindings, help * docs: tui docs * docs: updated tui docs * fix: nil handling for empty control * fix: additional nil pointer errors * fix: renamed to console * docs: updated console docs, lula-config --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Brandt Keller <43887158+brandtkeller@users.noreply.github.com> Co-authored-by: Cole (Mike) Winberry <86802655+mike-winberry@users.noreply.github.com> Co-authored-by: Brandt Keller <brandt.keller@defenseunicorns.com> Co-authored-by: Andy Mills <61879371+CloudBeard@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
brandtkeller
added a commit
that referenced
this pull request
Sep 20, 2024
* feat!(tui): initial commit * chore(deps): update actions/upload-artifact action to v4.3.6 (#575) | datasource | package | from | to | | ----------- | ----------------------- | ------ | ------ | | github-tags | actions/upload-artifact | v4.3.4 | v4.3.6 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update module github.com/open-policy-agent/opa to v0.67.1 (#577) | datasource | package | from | to | | ---------- | -------------------------------- | ------- | ------- | | go | github.com/open-policy-agent/opa | v0.67.0 | v0.67.1 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Megan Wolf <97549300+meganwolf0@users.noreply.github.com> * chore(deps): update github/codeql-action action to v3.26.0 (#582) | datasource | package | from | to | | ----------- | -------------------- | -------- | ------- | | github-tags | github/codeql-action | v3.25.15 | v3.26.0 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(generate): proposed transition of generation annotation to props (#574) * fix(generate): generation annotation in a prop * fix(generate): introduce framework flag to generate * chore(docs): add generation ns docs * feat(validation-result)!: bump to go-oscal v0.6.0 jsonschema v6 update (#544) * feat(validation-result)!: remove validation-result in favor of new go-oscal behavior chore(go-oscal): update w/ go-oscal jsonschema v6 changes * docs(reference): update jsonschema url, run go mod tidy to remove lingering jsonschemav5 inderect dep * test: update w/ current branch sha from go-oscal * chore(deps): bump go-oscal to v0.6.0 * fix(unit): cleanup whitespaces for composed artifact --------- Co-authored-by: Brandt Keller <brandt.keller@defenseunicorns.com> * fix(validate): get non-namespace scoped resources (#585) * fix(validate): get non-namespace scoped resources * fix(validate): alternate cluster-scoped resource get, schema mods * fix: updated conditional statement * docs: updated k8s domain doc * chore(deps): update dependency commitlint to v19.4.0 (#583) | datasource | package | from | to | | ---------- | ---------- | ------ | ------ | | npm | commitlint | 19.3.0 | 19.4.0 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(docs): initial SSP generation research docs (#548) * feat: initial-ssp-generate-doc * updated some wording * split ssp docs, updated some assessment result spellings. * ssp doc updates * broke assessment results at somepoint * updated note location * chore(docs): minor adjustments to intent and terms * chore(docs): cleanup testing artifacts * chore(docs): fix typos and add to dict --------- Co-authored-by: Brandt Keller <brandt.keller@defenseunicorns.com> Co-authored-by: Brandt Keller <43887158+brandtkeller@users.noreply.github.com> * chore(main): release 0.5.0 (#578) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * chore(docs): update issue template with expected deliverables line item (#590) * chore(deps): update anchore/sbom-action action to v0.17.1 (#593) | datasource | package | from | to | | ----------- | ------------------- | ------- | ------- | | github-tags | anchore/sbom-action | v0.17.0 | v0.17.1 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update github/codeql-action action to v3.26.1 (#595) | datasource | package | from | to | | ----------- | -------------------- | ------- | ------- | | github-tags | github/codeql-action | v3.26.0 | v3.26.1 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(docs): updated namespace doc locations and associated prop namespace url (#602) * fix: updated ns docs, ns prop * fix: remove test file feat: more tui design feat: more tui design feat: more tui design feat: more tui design * fix: removed debug bin * fix: removed rest files * fix: removed rest files * fix: fixed test expectations * feat: tui sizing, fixes * feat: updated keybindings, help * docs: tui docs * docs: updated tui docs * fix: nil handling for empty control * fix: additional nil pointer errors * fix: renamed to console * fix: overlay focus navigation * fix: updating keys/help * feat(console): adding edit fcns * feat(console): edit functionality updates updates to edit, plus other housekeeping/tech-debt modifications to try and simplify update functions * fix: go deps, removed debug.log * fix: updated testdata, redundant fcns * fix: updating model_test * fix: trying tempfile * fix: key-maps/help updates * fix: updated test files, increased timeout * fix: msgs, keys * test(console): additional console edit tests, testhelpers * fix: removed inject changes, dead code comment * docs(console): updated docs, gifs; added vhs tapes * fix: doc change, removed comments * fix: updated teatest * fix: save then close --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Brandt Keller <43887158+brandtkeller@users.noreply.github.com> Co-authored-by: Cole (Mike) Winberry <86802655+mike-winberry@users.noreply.github.com> Co-authored-by: Brandt Keller <brandt.keller@defenseunicorns.com> Co-authored-by: Andy Mills <61879371+CloudBeard@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This was referenced Oct 11, 2024
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 ssp generate document also has a digram in Miro that helps illustrate the depency graph.
! Due to the size of OSCAL Models including a Mermaid diagram is illegible.
This doc outlines the elements contained within the component-definition and profile that help fill out the ssp.
It also contains the items that are needed through a config file and the elements that need augmented within the component-definition.
Related Issue
Relates to https://github.com/orgs/defenseunicorns/projects/12/views/5?pane=issue&itemId=54551768
Type of change
Checklist before merging