Error in BugsPlaybook.PDF on Doc Team wiki

Bug #570432 reported by Connor Imes
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
ubuntu-docs (Ubuntu)
Won't Fix
Wishlist
Unassigned

Bug Description

Binary package hint: ubuntu-docs

Per https://lists.ubuntu.com/archives/ubuntu-doc/2010-March/014511.html

A small error in the BugsPlaybook.PDF file
(https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation?action=AttachFile&do=view&target=BugsPlaybook.pdf)

On page two under "Post It..."
It states to bzr commit then bzr diff.

These two should be reversed to place diff then commit otherwise you would need
to bzr diff -### >diff.txt
Where ### is the last revision prior to the commit.

----

Please remove the "bzr commit" line, this document is not describing using a separate branch for merging.

Tags: wiki
Revision history for this message
Dean Sas (dsas) wrote :

may be worth documenting doing a local commit and then doing bzr bundle > patchname.bundle rather than just a simple diff. bundles have the benefit of including the commit message and properly attributing the author when merged.

Changed in ubuntu-docs (Ubuntu):
status: New → Confirmed
John Kim (kotux)
tags: added: wiki
Revision history for this message
John Kim (kotux) wrote :

The bigger issue now is that the once useful playbook is outdated.

This document, if updated, could come in handy for incoming contributors. The concepts hold very well, but there are some things to change.
- doc team currently uses Mallard, which means the example and explanation needs a revamp (Find it and Change it)
- We don't have a ./scripts/validate.sh for mallard in saucy doc.
- yelp `pwd`?

I think bzr commit and push is more efficient than diff, though both methods are equally worth knowing.

Changed in ubuntu-docs (Ubuntu):
importance: Undecided → Wishlist
Revision history for this message
Gunnar Hjalmarsson (gunnarhj) wrote :

I don't think there is any link to that PDF any longer. Closing the bug.

Changed in ubuntu-docs (Ubuntu):
status: Confirmed → Won't Fix
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.