Skip to content
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

Jump to bottom

[Feature Request]: Add option for users to submit issues to the Docs #748

Closed
KOTungseth opened this issue Mar 14, 2025 · 0 comments · Fixed by #817
Closed

[Feature Request]: Add option for users to submit issues to the Docs #748

KOTungseth opened this issue Mar 14, 2025 · 0 comments · Fixed by #817
Assignees
@cotti
Labels
enhancement

Comments

@KOTungseth
Copy link

KOTungseth commented Mar 14, 2025 •
edited
Loading

What problem are you trying to solve?

We currently allow users to open PRs against the Docs with the Edit this page links in the right column of Docs pages. Users don't always want to open PRs to make changes to the Docs. We should make it easy for them to also open issues against the Docs.

Proposed Solution

Add a Report an issue link below Edit this page that opens an issue template in GitHub.

We have this community-request.yml GitHub issue template in docs-content.

Before we add the Report an issue link, we need to:

  • Update the template to include these options: Not clear, Missing information, Could be improved, and I can't find what I'm looking for
  • Work with source code repo owners to add template
  • Figure out how to auto populate page URL in issue template

How important is this feature to you?

Important
This was referenced Mar 21, 2025
Merged
Merged
@cotti cotti linked a pull request Mar 21, 2025 that will close this issue
Introduce a "Report an issue" link on documentation pages. #817
Merged
bmorelli25 added a commit to elastic/docs-content that referenced this issue Mar 24, 2025
@cotti @bmorelli25
Introduce an Issue Report template to be used by docsv3. (#886)
9a08b6e 
As a part of the changes required for
elastic/docs-builder#748, this PR introduces a
new template for issue reports to be consumed by a "`Report an issue`"
link in the documentation.

The `link` input will be populated by default with the page the user
came from.

---------

Co-authored-by: Brandon Morelli <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cotti cotti

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Introduce a "Report an issue" link on documentation pages. elastic/docs-builder
2 participants
@cotti @KOTungseth