feat: add custom issue url documentation#152
feat: add custom issue url documentation#152sempostma wants to merge 3 commits intodecaporg:mainfrom
Conversation
✅ Deploy Preview for decap-www ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Related to decaporg/decap-cms#7734 |
yanthomasdev
left a comment
There was a problem hiding this comment.
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`. |
There was a problem hiding this comment.
A few casing and grammar nits here
| 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`. |
There was a problem hiding this comment.
Thanks for spotting those, these are now fixed.
|
|
||
| ```yaml | ||
| issue_reports: | ||
| url: https://github.com/your-org/your-repo/issues/new |
There was a problem hiding this comment.
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:
| 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!
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
just a nit, the other URL here should be a comment so this sample works when copied without changes
| url: https://example.com/contact-support | |
| # url: https://example.com/contact-support |
Merge after decaporg/decap-cms#7734 is released