Update docs with docker install and other walkthrough improvements #666
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
aj-stein-gsa
force-pushed
the
659-update-or-create-necessary-installation-documentation
branch
from
b1d3725 to
487621e
Compare
|
Pushed to wrong branch for another PR. Restoring work and re-opened here for review tomorrow. |
Be sure to talk about the constraints and their relationship to the tool, do not just talk about the `oscal-cli` without context. Re-order some of the info, talk about target audience before install instructions.
aj-stein-gsa
force-pushed
the
659-update-or-create-necessary-installation-documentation
branch
from
d6d5b30 to
a9e68c1
Compare
aj-stein-gsa
force-pushed
the
659-update-or-create-necessary-installation-documentation
branch
from
c3a8821 to
c209659
Compare
Thanks to @david-waltermire for catching that.
Based on some more detailed feedback from @Rene2mt that matched other comments from Dave in the PR.
aj-stein-gsa
force-pushed
the
659-update-or-create-necessary-installation-documentation
branch
from
e79c153 to
4e02e2d
Compare
Gabeblis
reviewed
Sep 10, 2024
Rene2mt
previously approved these changes
Sep 10, 2024
aj-stein-gsa
merged commit 0083f06
into
GSA:feature/external-constraints
3 checks passed
aj-stein-gsa
added a commit
that referenced
this pull request
Sep 24, 2024
) * [skip ci] More appropriate README title for #659 * [skip ci] Context for constraints, tools for #659 Be sure to talk about the constraints and their relationship to the tool, do not just talk about the `oscal-cli` without context. Re-order some of the info, talk about target audience before install instructions. * [skip ci] Remove dupe copy of 'who for?' for #659 * [skip ci] Subject is FR not only FR devs in #659 * [skip ci] No more header numbers, add headers #659 * [skip ci] Better intro and simple diagram for #659 * [skip ci] Docker install prerequisites for #659 * [skip ci] More install and command docs for #659 * [skip ci] Clearer wording on OCI tool for #659 * [skip ci] Feedback for #659, re manual clone step * [skip ci] Remove dangling this for #659 Thanks to @david-waltermire for catching that. * [skip ci] Align arguments docs, examples for #659 Based on some more detailed feedback from @Rene2mt that matched other comments from Dave in the PR. * Good catch, @gabelis, fix numbering for #659
aj-stein-gsa
added a commit
that referenced
this pull request
Sep 25, 2024
) * [skip ci] More appropriate README title for #659 * [skip ci] Context for constraints, tools for #659 Be sure to talk about the constraints and their relationship to the tool, do not just talk about the `oscal-cli` without context. Re-order some of the info, talk about target audience before install instructions. * [skip ci] Remove dupe copy of 'who for?' for #659 * [skip ci] Subject is FR not only FR devs in #659 * [skip ci] No more header numbers, add headers #659 * [skip ci] Better intro and simple diagram for #659 * [skip ci] Docker install prerequisites for #659 * [skip ci] More install and command docs for #659 * [skip ci] Clearer wording on OCI tool for #659 * [skip ci] Feedback for #659, re manual clone step * [skip ci] Remove dangling this for #659 Thanks to @david-waltermire for catching that. * [skip ci] Align arguments docs, examples for #659 Based on some more detailed feedback from @Rene2mt that matched other comments from Dave in the PR. * Good catch, @gabelis, fix numbering for #659
brian-ruf
pushed a commit
to brian-ruf/fedramp-automation
that referenced
this pull request
Nov 8, 2024
…SA#666) * [skip ci] More appropriate README title for GSA#659 * [skip ci] Context for constraints, tools for GSA#659 Be sure to talk about the constraints and their relationship to the tool, do not just talk about the `oscal-cli` without context. Re-order some of the info, talk about target audience before install instructions. * [skip ci] Remove dupe copy of 'who for?' for GSA#659 * [skip ci] Subject is FR not only FR devs in GSA#659 * [skip ci] No more header numbers, add headers GSA#659 * [skip ci] Better intro and simple diagram for GSA#659 * [skip ci] Docker install prerequisites for GSA#659 * [skip ci] More install and command docs for GSA#659 * [skip ci] Clearer wording on OCI tool for GSA#659 * [skip ci] Feedback for GSA#659, re manual clone step * [skip ci] Remove dangling this for GSA#659 Thanks to @david-waltermire for catching that. * [skip ci] Align arguments docs, examples for GSA#659 Based on some more detailed feedback from @Rene2mt that matched other comments from Dave in the PR. * Good catch, @gabelis, fix numbering for GSA#659
This was referenced Nov 13, 2024
Closed
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.
Committer Notes
When merged, resolves #659.
All Submissions:
If applicable, have all FedRAMP Documents Related to OSCAL Adoption affected by the changes in this issue have been updated.?Changes the development doc in this repo, not the user-facing docs website.By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.