docs: updates README.md with Getting Started and design info #91
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
Signed-off-by: Jennifer Power <[email protected]>
gvauter
requested changes
May 21, 2024
README.md
Outdated
| The workflow to update content consists of the following steps: | ||
|
|
||
| 1. From a user's branch, modify and commit a markdown or json file within the workspace. (Most updates will be made to markdown files.) | ||
| 2. A user submits a pull request to add their changes to the workspace's master branch. |
There was a problem hiding this comment.
Suggest replacing master with main to align with step 4.
docs/design.md
Outdated
|
|
||
| The `create-new` workflow is triggered manually by going to the Action tab. This creates a new OSCAL profile in the trestle workspace. A new branch is created and a pull request is opened. | ||
|
|
||
| #### AutoFix |
There was a problem hiding this comment.
Would it ease understanding if this was titled "AutoSync" to align with the trestle-bot terminology?
Signed-off-by: Jennifer Power <[email protected]>
Signed-off-by: Jennifer Power <[email protected]>
|
@gvauter Please take another look. Due to changes in the CI files, this might require some testing on my fork as well. |
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.
Updates docs to use the same structure as
oscal-component-definitions. This replaces the manual tutorial (which is out of date) with a tutorial about how to interact with the repostiroy content through GitHub andtrestle-botactions. In depth approach information (like https://github.com/RedHatProductSecurity/oscal-component-definitions/blob/main/docs/design.md) is also added.Testing CI naming changes