Skip to content

feat: add custom issue url documentation #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sempostma wants to merge 3 commits into
base: main
Choose a base branch
from
+13 −0
Open

feat: add custom issue url documentation #152

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f656dbd
feat: add custom issue url documentation
sempostma Feb 26, 2026
856176b
fix: spelling issue
sempostma Mar 6, 2026
3d0829f
fix: add second example
sempostma Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions content/docs/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,19 @@ slug:
sanitize_replacement: "_"
```

## Issue Reports

When an error occurs in the CMS, users are presented with an option to report the issue. By default, this links to the Decap CMS GitHub repository. You can customize this URL to point to your own issue tracker using the `issue_reports` setting. If you are using a non-GitHub URL, you may want to [create a custom locale](#locale) and update the following translation key: `ui.errorBoundary.reportIt`.

**Example:**

```yaml
issue_reports:
url: https://github.com/your-org/your-repo/issues/new
Copy link
Contributor

@yanthomasdev yanthomasdev Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like the main motivation for this option is for non-technical people, so maybe we'd like the example to be more geared towards this type of user in particular?

Like this:

Suggested change
url: https://github.com/your-org/your-repo/issues/new
url: https://example.com/contact-support

I could be wrong, let me know what you think!

Copy link
Author

@sempostma sempostma Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Completely agree, I've listed them both as it illustrates both use cases.

# or
url: https://example.com/contact-support
Copy link
Contributor

@yanthomasdev yanthomasdev Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a nit, the other URL here should be a comment so this sample works when copied without changes

Suggested change
url: https://example.com/contact-support
# url: https://example.com/contact-support

```

## Collections

*This setting is required.*
Expand Down