diff --git a/docs/github-flow-getting-started.md b/docs/github-flow-getting-started.md index a60a13761..5651248c6 100644 --- a/docs/github-flow-getting-started.md +++ b/docs/github-flow-getting-started.md @@ -8,7 +8,11 @@ ### How do I setup the Github app? -- [Register a Github app](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app), with the options listed above +- [Register a Github app](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app), with the options listed below: + - Give your App a name and add a description + - Homepage URL: Can be anything (Example: repository URL) + - Add a dummy value for the webhook url, we'll come back to this setting + - Enter a webhook secret, which you'll need later on when filling in the `WebhookSecret` property in the `appsettings.json` file - Setup the following permissions - Repository - Contents - read and write @@ -19,8 +23,7 @@ - Issues - Issue comment - Allow this app to be installed by any user or organization - - Add a dummy value for the webhook url, we'll come back to this setting - - Enter a webhook secret, which you'll need later on when filling in the `WebhookSecret` property in the `appsettings.json` file + - After the app is created, generate a private key, we'll use it later for authentication to Github from the app ### Which labels should I create? @@ -95,4 +98,4 @@ As the last step, we also need to [load the WAF into the vector DB](#load-the-wa ### Load the WAF into Qdrant. If you are running the app locally, we have [Qdrant](https://qdrant.tech/) setup in the Codespace and if you are running in Azure, Qdrant is deployed to ACA. -The loader is a project in the `src\apps` folder, called `seed-memory`. We need to fill in the `appsettings.json` file in the `config` folder with the OpenAI details and the Qdrant endpoint, then just run the loader with `dotnet run` and you are ready to go. \ No newline at end of file +The loader is a project in the `src\apps` folder, called `seed-memory`. We need to fill in the `appsettings.json` file in the `config` folder with the OpenAI details and the Qdrant endpoint, then just run the loader with `dotnet run` and you are ready to go.