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

Introduce a "Report an issue" link on documentation pages. #817

Merged
merged 12 commits into from
Mar 25, 2025
Merged

Introduce a "Report an issue" link on documentation pages. #817

merged 12 commits into from
Mar 25, 2025

Conversation

cotti
Copy link
Contributor

@cotti cotti commented Mar 21, 2025 •
edited
Loading

Handles #748

The link's href is populated with the current window location to pre-fill the Github template.

Prerequisite: elastic/docs-content#886 should be merged.

@cotti
Introduce a "Report an issue" link on documentation pages.
87a1d1a 
The link's href is populated with the current window location to pre-fill the github template.
@cotti cotti added the feature label Mar 21, 2025
@cotti cotti self-assigned this Mar 21, 2025
@cotti cotti requested a review from a team as a code owner March 21, 2025 17:37
@cotti cotti linked an issue Mar 21, 2025 that may be closed by this pull request
[Feature Request]: Add option for users to submit issues to the Docs #748
Closed
@cotti cotti mentioned this pull request Mar 21, 2025
Merged
@cotti cotti requested a review from reakaleek March 25, 2025 04:39
reakaleek
reakaleek reviewed Mar 25, 2025
View reviewed changes
Copy link
Member

@reakaleek reakaleek left a comment

Choose a reason for hiding this comment

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

I'm not sure if it's working as expected.

Clicking on the link opens an empty issue.

Additionally, what do you think of opening the page in a new tab?
(Also the edit this page url.)

@cotti
Copy link
Contributor Author

cotti commented Mar 25, 2025

I'm not sure if it's working as expected.

Clicking on the link opens an empty issue.

Additionally, what do you think of opening the page in a new tab? (Also the edit this page url.)

Fixing it. I changed the dash to an underline...
I'll take the chance and adjust them to go to new tabs.

@reakaleek
Copy link
Member

I'm not sure if it's working as expected.
Clicking on the link opens an empty issue.
Additionally, what do you think of opening the page in a new tab? (Also the edit this page url.)

Fixing it. I changed the dash to an underline... I'll take the chance and adjust them to go to new tabs.

It looks like there is a problem with the issue template itself:
https://github.com/elastic/docs-content/blob/main/.github/ISSUE_TEMPLATE/issue-report.yaml

@cotti
Copy link
Contributor Author

cotti commented Mar 25, 2025

I see. Two Other got in there. The path was also wrong, so once it's fixed there we should be good. Sending a patch.

@cotti
Copy link
Contributor Author

cotti commented Mar 25, 2025

elastic/docs-content#911 fixes it there.

@cotti cotti requested a review from reakaleek March 25, 2025 13:38
@cotti cotti merged commit 2d12246 into main Mar 25, 2025
10 checks passed
@cotti cotti deleted the feature/report_issue_link branch March 25, 2025 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmorelli25 bmorelli25 bmorelli25 left review comments

@reakaleek reakaleek reakaleek approved these changes

Assignees

@cotti cotti

Labels
feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Add option for users to submit issues to the Docs
3 participants
@cotti @reakaleek @bmorelli25