Skip to main content

GitHub Discussions

Using GitHub Discussions as a source allows Kapa to pull Discussions from your GitHub repository. This allows Kapa to surface through conversations, extract valuable information and provide answers based on community-driven troubleshooting tips and technical discussions.

Step 1: Connect Your Repository​

  1. Go to the Sources tab on the Kapa platform and click on Add new source.

  2. Enter a name for the source, select GitHub Discussions, and click Continue.

  3. Specify the GitHub repository to use by filling in the Owner and Name fields.

  4. If it's a private repository, enter a personal access token for authenticating to GitHub. We recommend using a fine-grained access token.

    info

    The token must have access to the repository you're adding, with the following Repository permissions:

    • Contents: read-only
    • Discussions: read-only
    • Issues: read-only
    • Pull requests: read-only

If the connection is successful, a purple text box will appear providing you with the repository description.

Step 2: Configure Your GitHub Discussions​

Once you've set up your repository you can configure a set of parameters in order to only provide Kapa with the GitHub Discussions you find relevant.

  • Discussion State: Defines whether or not Kapa should only ingest Discussions that are open, closed or both.
  • Discussion Age: Defines the time limit of which Discussions should be included in the ingestion, depending on their opening date.
  • Discussion Labels: Defines what labels a Discussion should have in order to be included in the ingestion.

Tips & Tricks​

  • Filter For Solved Discussions: Consider adding a filter to only add Discussions that have been resolved to ensure a solution is available.
  • Limit To More Recent Discussions: We've seen that the Discussions that are most valuable are usually those than have been open/closed in the last 6-12 months. This varies widely for every project though.