jenkins.io
jenkins.io copied to clipboard
jenkins-infra
Issue Reporting page - No documentation for GitHub Issues
Problem with the Issue Reporting page, source file
The guide is built solely around Jenkins Jira. Some critical components like JCasC use GitHub Issues: https://github.com/jenkinsci/configuration-as-code-plugin/issues . The reporting flow for them is not documented.
Screenshots
TODO: Add screenshots if possible
Possible Solution
- Generalize guidelines so that they do not refer Jira where not needed
- Document the GitHub Issue reporting flow
- Document how to discover which bugtracker is used by the component. It will require manual steps until https://github.com/jenkins-infra/update-center2/pull/355 from @timja is implemented and added to the plugin site
Just do it @Chinmay922 ! Not that it is a not a newcomer-friendly task, it may need a few iterations
Are we officially supporting GitHub issues now? The thread on the mailing list was not resolved
Are we officially supporting GitHub issues now? The thread on the mailing list was not resolved
Yes, we're officially supporting GitHub issues for the jenkins.io documentation site. We used them extensively during the Hackfest last week. They worked very well.
Yes, we're officially supporting GitHub issues for the jenkins.io documentation site. We used them extensively during the Hackfest last week. They worked very wel
Yea but isn't this page about reporting issues for core / plugins?
Yea but isn't this page about reporting issues for core / plugins?
I think we'd like the page to be about reporting issues in the Jenkins project, whether with core, plugins, documentation, or infrastructure.
I would like to work in this. What approach should i take while addressing it can someone clarify on that. Thanks for your time.
I would like to work in this. What approach should i take while addressing it can someone clarify on that. Thanks for your time.
I think the description of the submission process for plugin issue reports should change so that instead of opening the Jira issue tracker and creating a new issue, the user is guided to the specific plugin page, then they are told to click the link "Report an issue" in the "Links" section on the right side of the page. That opens the correct location based on the configuration of the plugin.
Examples:
- Configuration as code plugin (GitHub) - https://github.com/jenkinsci/configuration-as-code-plugin/issues/new/choose
- Git client plugin (Jira) - https://www.jenkins.io/participate/report-issue/redirect/#17423
In both those cases, the page that is opened is more helpful for the user than if they create the issue directly in Jira. When they use the plugin link for Jira issues, they are guided to classify the new issue as either a bug, an enhancement, or a security issue. That initial guidance helps prevent security issues being reported in the wrong location.
I've added a PDF file of the web page with some markup comments to highlight the general areas that should be considered.
Thanks @MarkEWaite for the clarification. On the issue reporting page, we can ask the Reporter to identify where you are reporting the issue followed by two links like this
- Issue in Jenkins
- Issue in a Plugin
These links will reference to the section with the steps of issue reporting either for Issue in Jenkins or Issue in Plugin from the PDF file you've provided. Does this sound right to you ?
I have raised a PR with the changes @MarkEWaite suggested according to the PDF file. I have added some images for more clarity.