API docs need to contain bzr rev of source branch
Bug #1313749 reported by
Kyle Nitzsche
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Ubuntu API Website |
Confirmed
|
Medium
|
Unassigned | ||
Bug Description
The bzr revision of the branch from which API docs were built needs to be available in the corresponding published html docs.
Without this there is no way to know whether the published docs match the published API implementation.
And there is no way to refer to the published docs definitively in filing bugs and discussion them.
| Changed in ubuntudeveloperportal: | |
| importance: | Undecided → Medium |
Revision history for this message
| Kyle Nitzsche (knitzsche) wrote | #1 |
| Changed in ubuntudeveloperportal: | |
| status: | New → Confirmed |
| affects: | developer-ubuntu-com → ubuntu-api-website |
To post a comment you must log in.
Marking this Medium, since I think it really should be fixed.
This is a critical piece of missing information without which noone can reliably know what version of each api doc is published on the site and how it corresponds to released runtime code (pkgs + bzr rev). This lack of the ability to "connect the dots" is a recipe for problems.