From 675c0e270defe9508100952f18c19bbb3f6636da Mon Sep 17 00:00:00 2001 From: jpound Date: Tue, 3 Sep 2024 16:14:52 -0400 Subject: [PATCH] Update ASSESSMENT_TOOL.md Smoothing out flow. Signed-off-by: jpound --- organizations/ASSESSMENT_TOOL.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/organizations/ASSESSMENT_TOOL.md b/organizations/ASSESSMENT_TOOL.md index 3b80789..5f71f1a 100644 --- a/organizations/ASSESSMENT_TOOL.md +++ b/organizations/ASSESSMENT_TOOL.md @@ -2,7 +2,7 @@ # Assessment Tool -The assessment tool is a tool that allows you to assess the readiness of your pre-existing GitHub `repository`, before importing it with the toolkit. +The Assessment Tool allows you to assess the readiness of your pre-existing GitHub `repository`, before importing it with the toolkit. It is used to check whether toolkit guardrails are already in place in the `repository`, as well as any settings required at the `organization` level. ## Running the Assessment Tool @@ -16,4 +16,4 @@ To run an assessment check on a repository, run the following command: gh_foundations check ``` -Where `` is the organization slug to check. See the [documentation](https://github.com/FociSolutions/github-foundations-cli/blob/main/README.md#check) for more information. +`` is the organization slug to check. See the [documentation](https://github.com/FociSolutions/github-foundations-cli/blob/main/README.md#check) for more information.