Skip to content

Commit f96acc5

Browse files
committed
Fix docs
1 parent 34b43da commit f96acc5

2 files changed

Lines changed: 17 additions & 11 deletions

File tree

docs/github-app-setup.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GitHub App Setup
1+
# GitHub App Setup
22

33
The following steps will guide you through the process of setting up a GitHub App for the project. This setup is essential for the bot to function correctly and interact with GitHub's WebHook events.
44

@@ -53,7 +53,7 @@ In the General settings of the GitHub App, scroll down to the Display informatio
5353
In the App managers section of the GitHub App, you can add users who will be able to manage the app. This includes users who can install the app, view the app's settings, and manage the app's permissions. You can add users by their GitHub username or full name. This is optional, but it is recommended to add at least one user who will be responsible for managing the app.
5454

5555
### Step 1.5: Install the App
56-
In the organization settings, under the developer settings, click on GitHub Apps. Next to the GitHub App that you want to install, click Edit. Click Install App. Click Install next to the location where you want to install the GitHub App.
56+
In the organization settings, under the developer settings, click on GitHub Apps. Next to the GitHub App that you want to install, click Edit. Click Install App. Click Install next to the location where you want to install the GitHub App. Choose All Repositories.
5757

5858
### Step 1.6: Configure the repository access
5959
In the organization settings, under Third party-access, in the GitHub Apps section, Click on the "configure" button next to your app. In the repository access section, select **All repositories**.
@@ -65,7 +65,7 @@ In the repository that will be used for onboarding (the ones that has the issue
6565
- **APPROVED**: Support ticket approved and will be processed (Color: #7EF299)
6666
- **COMPLETED**: Support ticket completed (Color: #0E8A16)
6767
- **FAILED**: Validation checks failed (Color: #B60205)
68-
- **OPENE**D: Support ticket opened (Color: #1D76DB)
68+
- **OPENED**: Support ticket opened (Color: #1D76DB)
6969
- **REJECTED**: Support ticket rejected and will be closed automatically (Color: #E99695)
7070
- **VALIDATED**: Validation checks passed and configuration as code will be created (Color: #006B75)
7171

@@ -74,18 +74,18 @@ You can also get to this page by navigating to the following page: `https://gith
7474
### Step 2.2: Create the custom properties
7575
In the organization settings, under Repository, click on "Custom properties". Click on **New property** for each property listed below. Replace the placeholder with your appropriate values.
7676
**Ruleset property**<br/>
77-
- **Name**: <Name>-Ruleset
78-
- **Description**: The rulesets applied to repository using the <GitHub App name> App.
77+
- **Name**: \<Name\>-Ruleset
78+
- **Description**: The rulesets applied to repository using the \<GitHub App name\> App.
7979
- **Type**: Multi select
8080
- Options: add as many as you see fit, depending on how many rulesets you plan to have.
81-
- **<GitHub App name>-Ruleset-Default**: The default ruleset that can be applied to all repositories
81+
- **\<GitHub App name\>-Ruleset-Default**: The default ruleset that can be applied to all repositories
8282
- Check the box for **Allow repository actors to set this property**.
8383
- Check the box for **Require this property for all repositories** and pick the default value to the default value that you have set in the options above.
8484

85-
**<Name> property**<br/>
85+
**\<Name\> property**<br/>
8686
This property is used as a flag to indicate that the repository was onboarded using the GitHub App.<br/>
87-
- **Name**: <Name>
88-
- **Description**: Flag to indicate that the repository was onboarded using the <GitHub App name> App
87+
- **Name**: \<Name\>
88+
- **Description**: Flag to indicate that the repository was onboarded using the \<GitHub App name\> App
8989
- **Type**: true/false
9090
- Check the box for **Allow repository actors to set this property**.
9191
- Check the box for **Require this property for all repositories** and pick the default value to the default value that you have set
@@ -94,3 +94,4 @@ This property is used as a flag to indicate that the repository was onboarded us
9494
In the organization settings, under Repository, click on "Rulesets". Click on "New ruleset". Select the ruleset type ou want to create whether they are branch ruleset, tag ruleset or push ruleset.<br/><br/>
9595
We strongly recommend to create a ruleset with the following configuration:<br/><br/>
9696
In Targets, under the Target repositories, pick the target **Dynamic list by property**. For the property, select the property create in Step 2.2. For the value, select the value **GitHub App**. This will ensure that the ruleset is applied to all repositories that have the property GitHub App set to GitHub App.
97+
The ruleset enforcement status should be set to **Active**.

docs/main.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This application is built using .NET Core. It supports multiple data stores, inc
3535
| `Azure:AzureMonitor:EnableTelemetry` | String | Whether to enable telemetry or not. |
3636
| `Azure:AzureMonitor:UseEntraIdAuthentication` | String | When telemetry is enabled, whether to use entra for authentication vs Instrumentation Key. |
3737
| `DataStore:Type` | String | Type of data store (FileSystem, CosmosDb, SqlServer). |
38-
| `DataStore:FileSystem:FilePath` | String | File path for file system data store. |
38+
| `DataStore:FileSystem:FilePath` | String | File path for file system data store. This is a directory. |
3939
| `DataStore:CosmosDb:Database` | String | Database name for Cosmos DB. |
4040
| `DataStore:CosmosDb:ConnectionString` | String | Connection string for Cosmos DB. |
4141
| `DataStore:CosmosDb:GitHubWebhooksContainer` | String | Container for GitHub webhooks in Cosmos DB. |
@@ -118,4 +118,9 @@ Follows the .NET FeatureManagement [schema](https://learn.microsoft.com/en-us/az
118118

119119
## [GitHub setup](#github-setup)
120120

121-
Before you can use the GitHub DevEx Accelerator, you need to set up a GitHub App and configure it with the necessary permissions. Please follow the guide [here](./docs/github-app-setup.md) to do so.
121+
Before you can use the GitHub DevEx Accelerator, you need to set up a GitHub App and configure it with the necessary permissions. Please follow the guide [here](./docs/github-app-setup.md) to do so.
122+
123+
You will also need to create 3 repositories in your organization:
124+
- **\<onboarding-repository-name\>**: This repository will be used for onboarding. It should contain the issue templates that will be used for onboarding.
125+
- **\<inventory-repository-name\>**: This repository will be used for inventory. It will contain the inventory metadata.
126+
- **\<policy-repository-name\>**: This repository will be used for the policies. It will contain the policies metadata.

0 commit comments

Comments
 (0)