Skip to content

feat: add custom issue url documentation#152

Open
sempostma wants to merge 3 commits intodecaporg:mainfrom
laikacms:feat/custom-issue-url
Open

feat: add custom issue url documentation#152
sempostma wants to merge 3 commits intodecaporg:mainfrom
laikacms:feat/custom-issue-url

Conversation

@sempostma
Copy link

@sempostma sempostma commented Feb 26, 2026

Merge after decaporg/decap-cms#7734 is released

@netlify
Copy link

netlify bot commented Feb 26, 2026

Deploy Preview for decap-www ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 3d0829f
🔍 Latest deploy log https://app.netlify.com/projects/decap-www/deploys/69aa9664f6262000089fd21b
😎 Deploy Preview https://deploy-preview-152--decap-www.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@sempostma
Copy link
Author

sempostma commented Feb 26, 2026

Related to decaporg/decap-cms#7734

@martinjagodic martinjagodic added the pending feature release Marks docs PRs that are waiting for a PR on the main repo label Feb 26, 2026
Copy link
Contributor

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

Thanks @sempostma, I have a few improvements and a question


## 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 following translation key: `ui.errorBoundary.reportIt`.
Copy link
Contributor

Choose a reason for hiding this comment

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

A few casing and grammar nits here

Suggested change
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 following translation key: `ui.errorBoundary.reportIt`.
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`.

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for spotting those, these are now fixed.


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

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

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.

issue_reports:
url: https://github.com/your-org/your-repo/issues/new
# or
url: https://example.com/contact-support
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending feature release Marks docs PRs that are waiting for a PR on the main repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants