Octri

GitHub Issues

Open GitHub issues from monitoring errors and docs feedback, in a repository of yours.

What you need

GitHub Issues goes through the Octri GitHub App, so it needs no token of its own. Install the App on the project first, from GitHub sync, and give it the Issues permission on the repository.

Connect it

  1. Open Integrations

    Open Integrations in the project sidebar and choose GitHub Issues under Issue tracking.

  2. Fill in the details

    Type the repository as owner/repo. The App's installation must be able to see it.

  3. Press Connect

    Octri checks the details with GitHub Issues before it saves, and says what's wrong if GitHub Issues refuses them.

Settings

Repositoryowner/reporequired

Letters, digits, dots, underscores and hyphens on each side of the slash.

From a monitoring issue

Open an issue in Monitoring, on the Issues tab, and press Create issue. If several trackers are connected, pick one first. Octri opens one GitHub Issues issue per monitoring issue: after that, the button is a link to it, labelled with its number, such as #42.

The issue is titled with the error, and says:

  • how many times it was seen, by how many users, and when first and last
  • the endpoint, as method and path, when there is one
  • the culprit, when there is one
  • a link back to the project's issues in Octri
  • the last stack trace, as a code block

From docs feedback

Turn on Send docs feedback here on the GitHub Issues card to collect what readers say about your docs. With page feedback on, a reader who votes No is asked what was missing. The first comment on a page opens a issue titled Docs feedback: <page>, and later comments on that page are added to it, so each page collects its feedback in one place.

Octri passes each comment on and doesn't keep it. Votes are counted in Octri either way.

When it refuses

MessageWhat to do
The Octri GitHub App can't see that repository.The App isn't installed on the repository's owner, or isn't given that repository.
The Octri GitHub App can't write issues in that repository.The installation lacks the Issues: write permission. Accept the new permission in GitHub.
Issues are turned off in that repository.Turn on Issues in the repository's settings.

Disconnect

Press Disconnect on the card. GitHub Issues issues already opened stay where they are. If GitHub Issues was receiving docs feedback, readers' comments stop being asked for until another tracker takes it.

Connecting and changing trackers needs permission to edit project settings. Opening an issue from monitoring needs permission to edit monitoring. See organizations and roles.