/srv/irclogs.ubuntu.com/2011/04/26/#ubuntu-doc.txt

jbichamimico: I'm thinking about stubbing the booklet pages from Ubuntu's help for this release03:45
jbichabecause LO doesn't need it03:46
mimicojbicha, you mean take them out completely?03:49
mimicoI think they mainly pertain to Evince anyways.03:50
Captainkrtekhello03:51
jbichamimico: basically, maybe they could be cleaned up for a later release03:52
Captainkrtekinterested in getting involved with the doc. team03:53
Captainkrtekreading up on it03:53
jbichaCaptainkrtek: have you used bzr before?03:55
mimicojbicha, it was written initially with only Evince in mind, so taking it out is okay by me.03:55
Captainkrtekjbicha, I'm afraid I have not03:56
jbichamimico: ok, thank you03:56
Captainkrtekbut I have experience in MediaWiki, technical writing, and open source documentation and development03:56
Captainkrtekmostly for Android03:56
jbichaunfortunately we don't use MediaWiki03:59
Captainkrtekyeah03:59
Captainkrtekbut I have the writing experience03:59
CaptainkrtekI have also written for a portal with over 3-4 Million views a month03:59
jbichathere's 2 parts to docs, the wiki & the user help03:59
Captainkrtekon technical topics03:59
Captainkrtekyeah03:59
CaptainkrtekI'd be interested more in the wiki03:59
Captainkrtekspent lots of time in wikis04:00
Captainkrtekwhat about the documentation onboard the OS?04:01
Captainkrtekor do you have to first prove yourself04:01
jbichano, for the system docs, you'll just need to learn bzr :-)04:02
Captainkrtekive used GIT before04:03
Captainkrtekand gerrit04:03
jbichaand the docs are written in mallard (older docs are written in docbook)04:03
Captainkrtekso i've used revision control before04:03
Captainkrtekgotcha04:03
Captainkrteklots to learn :-)04:03
jbichayeah, bzr is similar to git but different04:04
jbichahttps://wiki.ubuntu.com/UbuntuDevelopment/GettingSetUp04:04
jbichayou need a GPG key and do the stuff in setting up your dev environment04:05
Captainkrtektrying to setup my key right now04:05
Captainkrtekis it a huge learning curve from GIT?04:06
jbichaI've used bzr more so I couldn't tell you04:09
jbichaI think newer bzr users don't like git because it's more complex, git users don't like bzr04:09
jbichabecause it's slower & doesn't do everything git can04:09
Captainkrtekhmm04:10
Captainkrtekill have to check it out04:10
CaptainkrtekI'd love to give back through this community :)04:10
Captainkrtekgenerating the key04:13
Captainkrtekthis is taking a bit :P04:13
Captainkrtekso what do you work on jbicha ?04:18
jbichaI've been getting the user guide into shape for Natty, basically changing the Gnome 304:20
jbichastuff to describe Unity instead04:20
Captainkrtekcool :-)04:20
CaptainkrtekI have not upgraded to natty yet04:20
Captainkrtekprobably should do that04:21
Captainkrtekk gpg and ssh keys setup04:32
Captainkrtekjbicha, K I went through that whole guide04:39
jbichaok, the pbuilder part isn't needed for documentation04:40
Captainkrtekoh okay04:40
Captainkrtekstill did it hehe04:40
Captainkrtekso where can I get started?04:40
Captainkrteklooking at some pages...04:41
jbichahttps://code.launchpad.net/~ubuntu-branches/ubuntu/natty/gnome-user-docs/natty04:41
jbichaoops, that's not it04:41
Captainkrtekhehe04:42
Captainkrtekmy launchpad id is steven.richards btw04:42
jbichahttps://code.launchpad.net/~ubuntu-core-doc/gnome-user-docs/natty04:42
jbichaso as you can see on that page, you'll need to run04:43
jbichabzr branch lp:~ubuntu-core-doc/gnome-user-docs/natty04:43
Captainkrtekyeah04:43
Captainkrtekrunning :)04:43
jbichalet me know when it's done downloading04:43
Captainkrtekokay!04:43
Captainkrtekthanks for getting me set up I appreciate it :)04:44
Captainkrtekjbicha, it's done04:52
jbichaok, conveniently the help doesn't require compilation to be viewed04:53
Captainkrtekk04:53
jbichaso you can just cd into gnome-help/C/04:53
jbichaand then run yelp .04:53
jbichato view the help as of right now04:53
Captainkrtekvery cool04:54
jbichabut it won't look quite right if you're not using yelp 3 which is in natty04:55
Captainkrtekgotcha04:55
Captainkrtekm running 10.1004:55
Captainkrtekim*04:55
Captainkrtekso go through the files04:55
Captainkrtekedit them04:55
Captainkrteksave em04:55
Captainkrtekhow would I submit the change using bzr?04:55
jbichahttps://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/Submitting04:56
jbichaeither bzr bundle and email the mailing list04:56
Captainkrtekand then for04:56
Captainkrtekbzr push lp:~yourusername/ubuntu-docs/branchname04:56
CaptainkrtekId to04:56
Captainkrtekbzr push lp:~krtek/natty/gnome-help/C04:57
Captainkrteks/to/do04:57
jbichaI do it more like bzr push lp:~jbicha/gnome-user-docs/display-typos04:58
Captainkrtekoh04:59
Captainkrtekwhat's the difference?05:00
Captainkrtekif im working in /C05:00
jbichabecause the final part is your branch name and you can pick whatever you like05:00
Captainkrtekahh05:00
Captainkrtekso no difference really05:00
jbichamight as well make it easy to recognize what that branch does05:00
Captainkrtekyeah05:01
Captainkrtekand then the files tagged .stub05:01
Captainkrtekarent done yet05:01
jbicharight, so not visible to users, but you can do yelp --editor-mode .05:01
jbichaif you really want to see them or read comments05:02
CaptainkrtekUnknown option --editor-mode05:02
Captainkrtekthat only in yelp 3?05:03
jbichaI guess, you can check yelp --help05:03
jbichait doesn't actually edit, it just shows some extra stuff05:04
Captainkrtekhey jbicha sorry about that05:09
Captainkrtekwifi cut out05:09
jbichanp05:09
Captainkrtekwhat editor do you use05:09
jbichagedit actually05:11
Captainkrtekme too :)05:11
Captainkrtekand what is the syntax called we are writing in?05:12
Captainkrtekneed to find a guide05:12
jbichahttp://projectmallard.org/05:12
Captainkrtekbookmarked05:13
Captainkrtektime to get to work05:13
Captainkrtekthanks again for the help!05:13
jbichaI pushed an update, so you can do bzr pull to get the latest05:20
Captainkrtekvery cool, updating now :)05:20
CaptainkrtekIm going to try to make a change05:20
Captainkrtekquick question if you don't mind05:22
Captainkrtekhello mimico06:42
Captainkrtekdo you have a minute to help answer a question?06:43
Captainkrtekor anyone06:46
Captainkrtekjbicha, you still around?06:47
jbichaCaptainkrtek: yes, for a bit longer06:47
Captainkrtekokay great06:47
Captainkrtekso I just edited display-2monitors.page.stub06:47
Captainkrtekran the check_validation.sh06:48
jbicha./check_status.sh is useful06:48
Captainkrteksaid it validates06:48
Captainkrtekno return on check_status06:48
CaptainkrtekI can't yelp display-2monitors.page.stub either.06:48
Captainkrtekany idea?06:49
jbichabzr mv display-2monitors.page.stub display-2monitors.page06:50
jbichaand then yelp . will show it06:50
Captainkrtekhe requested URI "display-2monitors.page" is invalid06:51
CaptainkrtekThe*06:51
jbichaum, are you sure it validates then?06:51
Captainkrtekkrtek@krtek:~/natty/gnome-help/C$ ./check_validation.sh display-2monitors.page06:52
Captainkrtek --Validating display-2monitors.page ...06:52
Captainkrtekdisplay-2monitors.page validates06:52
Captainkrtek:/06:52
jbichajust do yelp . don't try specifying the specific page06:52
Captainkrtekthen search for it?06:53
jbichayes, there's a trick to do a specific page in yelp 2.32 but I'd have to google it06:53
jbichaeverything I own is running Natty at the moment06:53
Captainkrtekhmm06:53
Captainkrtekcan I pastebin the file?06:54
Captainkrteksee if it looks right to you?06:54
jbichadid you get it to open yet?06:54
Captainkrteknope :/06:54
Captainkrtekhttp://pastebin.com/M9FpmjD606:54
Captainkrtekcouldn't find it06:54
Captainkrtekoh wait06:54
Captainkrtekhmmm06:55
Captainkrtekcan't find it...06:55
Captainkrtekoh06:56
Captainkrtekfound it :)06:56
jbichagood06:57
Captainkrtekwasn't easy06:57
Captainkrtekis there a way to submit an update but not a final one?06:57
Captainkrteklike I will make changes to this one06:57
jbichait would be better to get it mostly final before submitting06:57
Captainkrtekyeah06:57
Captainkrtekdid the pastebin look okay?06:57
Captainkrtekneed to read the style guide...06:58
jbichawell it needs more work, you'd probably find it easier to read or edit existing pages instead of creating a stub06:58
Captainkrtekokay06:58
CaptainkrtekI just found that one06:59
Captainkrtekthat was an existing stub06:59
jbichayou picked an important topic but it's ok if it doesn't get done in time for 11.0406:59
CaptainkrtekI can get it done tomorrow hopefully06:59
jbichayes, the stub is from Gnome06:59
Captainkrtekhow long will it take to get approved?06:59
jbichareview shouldn't take more than a couple days at most, maybe much faster07:00
jbichaapproval depends on quality :-)07:00
Captainkrtekokay07:01
Captainkrtekany tips for me07:01
jbichawe appreciate the help07:01
Captainkrtekbased on that pastebin?07:01
jbichadon't use tabs, use spaces07:01
jbichaspellcheck, compare to already existing pages for tricks like guiseq07:02
Captainkrtekokay07:02
Captainkrtekso like download an old branch?07:02
jbichano, compare to other pages in the guide07:02
Captainkrtekwhat about detail? is that long enough07:02
Captainkrtekokay07:02
jbichato learn how to use the syntax07:02
Captainkrtekyeah07:02
Captainkrtekis there a way to include images?07:02
Captainkrteklike screenshots07:02
jbichayes, but space is limited so I'm not sure if we actually need one07:03
Captainkrtekokay07:03
jbichathe gnome-user-guide is shipped on the CD07:03
Captainkrtekahh07:03
Captainkrtekwow07:03
Captainkrtek:)07:03
Captainkrtekmaybe I can get something on there before release :)07:04
jbicha11.04's CD is basically done though07:04
Captainkrtekoh07:04
jbichano, they'll only rebuild the CD image for urgent bugfixes07:04
Captainkrtekdarn07:04
Captainkrtekbut there are updates07:04
jbichayes07:05
Captainkrtek:)07:05
Captainkrtekvery cool07:05
jbichayes, it's neat to see your name in the changelog07:06
Captainkrtekyeah07:07
Captainkrtekit's a cool project07:07
Captainkrtekhow long have you been doing this?07:07
Captainkrtekalso, is this, http://pastebin.com/4Z9XgnaR , what should be in the guide?07:08
jbichaabout 3 weeks for the user guide, I had a bunch of free time07:09
jbichacomments aren't visible to end users, it was just notes from Gnome about what they thought should be on the page07:11
jbichaa significant amount of Gnome's guide was only written in March07:12
jbichahttp://j1m.net/2011/03/19/gnome-3-documentation-hackfest/07:12
jbichabut I was interested in Gnome help for a year, I should have jumped in sooner07:14
Captainkrtekhey07:18
Captainkrteksorry had to reconnect07:18
jbichabut I was interested in Gnome help for a year, I should have jumped in sooner07:19
Captainkrtekcool07:19
CaptainkrtekI have a friend who does some gnome work07:19
Captainkrtekthink he does design07:19
jbichait's a bit easier to write & edit the new help once more of it is written07:19
jbichaback then, Mallard was quite new07:19
Captainkrtekyeah07:19
Captainkrtekhow do you edit the sub title text on yelp for an item?07:20
Captainkrteklike this07:20
Captainkrtekhttp://i.imgur.com/ax6Qu.png07:20
Captainkrteksee there is no text below second monitor07:21
jbichathat's the desc field07:21
Captainkrtekgot it :)07:22
Captainkrtekthanks07:22
Captainkrtekshouldn't dual displays go under hardware?07:27
Captainkrtekoh nvm07:27
Captainkrtekif you're still here just have one final thing07:29
jbichaok07:30
Captainkrtekthe comment section07:30
Captainkrtekis that a request, like "please include details on blah blah blah"07:31
jbichaif you're able to include the important stuff then you don't need to write comments07:34
Captainkrtekk07:34
Captainkrtekmight  be able to get this one close to done tonight07:34
jbichait is a note to other writers and editors07:34
Captainkrtekgotcha07:34
CaptainkrtekThink I have this one done :)07:44
jbichaI'm done for tonight, talk to you later!07:46
Captainkrtekokay me as well, goodnight!07:46
Captainkrtekhey dpm08:13
dpmwell, that was a short conversation08:17
=== czajkows1i is now known as czajkowski
jbichamdke: howdy22:37
mdkejbicha: heya22:37
jbichaI thought it would simpler to link to an app than telling users to search for one or22:38
mdkeI think the instructions should be app independent really22:39
jbichatelling them to click through Get Software, down arrow, Canonical Partners22:39
mdkeideally there would be a check box in software sources for the partner repo, as there was in previous releases, but I didn't see one when I tested so I used the apt line22:39
jbichaoh, there's a check box22:40
mdkeperhaps it was added after the version I have got22:40
mdkeI'm a week or two out of date22:40
jbichait could be because you've been upgrading for a while22:41
mdkeI haven't upgraded at all, I have a daily live usb from the daily snapshot a week or two ago22:42
mdkebut I haven't kept it up to date as that takes up a lot of disk space22:42
jbichainterestingly, if you delete the "Canonical Partners" repo from Software Sources, the "Use This Source" button can add it back for you22:42
* mdke nods22:43
mdkejbicha: to change the subject briefly, have you by any chance gone over the topics which you reviewed prior to getting commit access and marked them as final? If not that would be useful.22:43
mdkeYou've made amazing progress over the last few days22:43
mdke== SUMMARY ==22:44
mdkeNone:  022:44
mdkeStub:  622:44
mdkeIncomplete:  122:44
mdkeDraft:  322:44
mdkeReview:  2322:44
mdkeCandidate:  1022:44
mdkeFinal:  9222:44
mdkeOutdated:  9222:44
mdkepretty awesome :)22:44
mdkebbl22:44
Captainkrtekhello23:44
Captainkrtekjbicha, you here?23:44
jbichaCaptainkrtek: hi23:44
Captainkrtekhello23:44
Captainkrtekso last night I finished a doc23:45
Captainkrtekcommitted locally23:45
Captainkrtekand emailed the mailing list23:45
Captainkrtekbut I dont think anyone has seen it23:45
jbichano, we saw it23:46
Captainkrtekoh okay :)23:46
jbichayou should upgrade to 11.0423:46
Captainkrtekyeah23:46
CaptainkrtekI was going to last night23:46
CaptainkrtekI will in about 20 minutes, is it good though?23:47
jbichathe user guide is written based on the Unity desktop, so System>Preferences>Monitors isn't how we do it now23:47
Captainkrtekoh....23:47
Captainkrtekwhoops23:47
Captainkrtekso I'll rewrite it23:48
Captainkrtekonce I upgrade23:48
Captainkrtekother than that issue, how is it style wise? I tried using some syntax from the mallard docs23:49
jbichause status="review" instead of making up a status23:52
Captainkrtekoh23:53
CaptainkrtekI didn't make that up23:53
CaptainkrtekI saw it somewhere in the editing guide23:53
jbichathe wiki? the wiki talks about docbook so it's out of date23:54
Captainkrtekhttps://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/Checking23:54
Captainkrtekon the bottom23:55
CaptainkrtekI used "writing" if I remember right23:55
jbichathat page was last edited 2 years ago :-)23:55
Captainkrtekwhoops23:56
Captainkrtekhehe23:56
Captainkrtekdidn't know where else to look23:56
jbichabasically projectmallard and already existing docs are where you should look23:56
Captainkrtekokay gotcha23:57
Captainkrtekthanks for all the help23:57
Captainkrteksorry for bothering23:57
jbichawe're going to update the wiki but because we're trying to finish up natty's docs it might not get done this week23:57
Captainkrtekokay23:57
jbichano, you're not a bother at all23:57
Captainkrtekwell thanks for your patience in helping a nuub :-)23:58

Generated by irclog2html.py 2.7 by Marius Gedminas - find it at mg.pov.lt!