#3754 [RFE] Add "Report a bug" link to public documentation
Closed: Fixed None Opened 10 years ago by pspacek.

We could add "Report a bug/ambiguity" links to the Fedora docs at http://docs.fedoraproject.org/en-US/Fedora/18/html/FreeIPA_Guide/index.html.

This could encourage people to report which parts of docs are not clear enough etc.


There is this in the feedback section:

If there is any error in this book or there is any way to improve the documentation, please let us know. Bugs can be filed against the documentation for FreeIPA through Bugzilla, http://bugzilla.redhat.com/bugzilla. Make the bug report as specific as possible, so we can be more effective in correcting any issues:

1.
Select the Community group and the freeIPA product.

2.
Set the component to Documentation.

3.
Set the version number to 2.2.

4.
For errors, give the page number (for the PDF) or URL (for the HTML), and give a succinct description of the problem, such as incorrect procedure or typo.

For enhancements, put in what information needs to be added and why.

5.
Give a clear title for the bug. For example, "Incorrect command example for setup script options" is better than "Bad example".

Link:
http://docs.fedoraproject.org/en-US/Fedora/18/html/FreeIPA_Guide/feedback.html

Yes, you are right, there is existing way for bug reporting.

The proposal is about automating steps 1-4 via the auto-generated link. This would reduce the pain for the reporter and (hopefully) raise amount of bug reports.

3.4 development was shifted by one month, moving tickets to reflect reality better.

This is a simple fix, I can do it.

Patch freeipa-mkosek-432-add-direct-bug-reporting-links-to-feedback-section.patch sent for review

Adjusting time plan - 3.4 development was postponed as we focused on 3.3.x testing and stabilization.

Moving unfinished November tickets to January.

master: 09f7a0b38a28cf88cb3583fe237d19b82438bd86

Metadata Update from @pspacek:
- Issue assigned to mkosek
- Issue set to the milestone: FreeIPA 4.0 Backlog

7 years ago

Login to comment on this ticket.

Metadata