From 3be46ae521ca1ee80001d9b01f986df77d37f09f Mon Sep 17 00:00:00 2001 From: Jennifer Power Date: Mon, 16 Oct 2023 12:33:58 -0400 Subject: [PATCH] docs: adds grammar fixes and clarity to README.md files and contributing guide Signed-off-by: Jennifer Power --- CONTRIBUTING.md | 4 ++-- README.md | 6 +++--- actions/README.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1debe40..cbaddb4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,12 +39,12 @@ For workflow diagrams, see the [diagrams](./docs/diagrams/) under the `docs` fol 1. CI Provider - Runs or builds and runs trestle-bot container 2. Trestle Bot - Provides logic for managing workspace and containerized environment for use in workflows -3. Compliance-Trestle - Upstream library that provided core logic for how OSCAL content is managed +3. Compliance-Trestle - Upstream library that provides core logic for how OSCAL content is managed #### Code structure - `actions` - Provides specific logic for `trestle-bot` tasks that are packaged as Actions. See [README.md](./actions/README.md) for more information. -- `entrypoints` - Provides top level logic for specific tasks. These tasks are not necessarily related in any so they are not organized into a hierarchical command structure, but they do inherit logic and flag from a base class. +- `entrypoints` - Provides top level logic for specific user-facing tasks. These tasks are not necessarily related in any way so they are not organized into a hierarchical command structure, but they do inherit logic and flags from a base class. - `provider.py, github.py, and gitlab.py` - Git provider abstract class and concrete implementations for interacting with the API. - `tasks` - Pre-tasks can be configured before the main git logic is run. Any task that does workspace management should go here. - `tasks/authored` - The `authored` package contains logic for managing authoring tasks for single instances of a top-level OSCAL model. These encapsulate logic from the `compliance-trestle` library and allows loose coupling between `tasks` and `authored` types. diff --git a/README.md b/README.md index 85271251..5d8a6ad3 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ trestle-bot assists users in leveraging [Compliance-Trestle](https://github.com/ ### GitHub Actions -For detailed documentation on how to use each action see the README.md each each folder under [actions](./actions/). +For detailed documentation on how to use each action, see the README.md in each folder under [actions](./actions/). -The `autosync` action will sync trestle-generated Markdown files to OSCAL JSON files in a trestle workspace. All content under the provided markdown directory when the action is run. This action supports all top-level models [supported by compliance-trestle for authoring](https://ibm.github.io/compliance-trestle/tutorials/ssp_profile_catalog_authoring/ssp_profile_catalog_authoring/). +The `autosync` action will sync trestle-generated Markdown files to OSCAL JSON files in a trestle workspace. All content under the provided markdown directory when the action is run will be transformed. This action supports all top-level models [supported by compliance-trestle for authoring](https://ibm.github.io/compliance-trestle/tutorials/ssp_profile_catalog_authoring/ssp_profile_catalog_authoring/). The `rules-transform` actions can be used when managing [OSCAL Component Definitions](https://pages.nist.gov/OSCAL-Reference/models/v1.1.1/component-definition/json-outline/) in a trestle workspace. The action will transform rules defined in the rules YAML view to an OSCAL Component Definition JSON file. @@ -35,7 +35,7 @@ podman run -v $(pwd):/data -w /data quay.io/continuouscompliance/trestle-bot: Note to contributors: We are trying to limit the task that we expose as actions to workspace manage operations and checks only. +> Note to contributors: We are trying to limit the tasks that we expose as actions to workspace manage operations and checks only. First, create an entrypoint script for the new action in the `trestlebot/entrypoints` directory. Then add the action by creating a new directory in the `actions` directory with an `action.yml` that references your new entrypoint. See the [GitHub Actions documentation](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action) for more information.