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

philbullhi guys14:51
philbullanyone here for the Installation Guide meeting?14:51
DougieRichardsonphilbull: yes14:52
philbullhey dougie14:52
DougieRichardsonphilbull: hi mate14:53
KelvinGardiner1hi14:55
philbullhi kelvin14:55
DougieRichardsonhi kelvin14:56
KelvinGardiner1hello Dougie14:56
DougieRichardsonRocket2DMn: I think phil's here for the meeting (not yesterday, lol)14:57
Rocket2DMno/14:58
philbullOK, we should probably begin15:03
philbullThe spec is here: https://wiki.ubuntu.com/Specs/KarmicInstallationGuide15:04
philbullI was looking at some web stats for the wiki the other day, and it's clear that installation-related pages are really popular15:05
philbullYou can see for yourself: https://help.ubuntu.com/community/PageHits15:05
philbullWe currently have 2 official docs on installation:15:05
philbullthe Installation Guide https://help.ubuntu.com/9.04/installation-guide/index.html15:06
philbulland the Switching from Windows guide https://help.ubuntu.com/9.04/switching/index.html15:06
philbullThe Installation Guide is just the Debian guide with some modifications15:07
philbullas a result, it's technical and not really suitable for most new users15:07
philbullThe SFW guide is pretty out-of-date, so that's not much use either15:07
philbullMy plan is to produce a guide which is tightly-focussed on guiding non-technical users through installation15:08
philbullWhat are people's thoughts on this idea?15:09
Rocket2DMnYou said that the SFW guide was out of date, why not update this instead of making a new document?15:09
mdkeit's a great idea, we've needed a good installation guide for ages15:10
mdkethere should be plenty of material on the wiki to work with15:10
philbullMuch of the SFW guide looks at migrating data and settings15:10
philbullit was written before the Migration Assistant15:11
philbullAs such, most of it's obsolete15:11
philbullIt's also full of crap that users probably don't care about15:11
philbull(it's my fault, I wrote most of it)15:11
KelvinGardiner1I think its a good idea. The current guide have a lot of text and few screen shots to guide new users.15:11
Rocket2DMnSo are you intending to do away with that SFW?15:11
philbullRocket2DMn: yes, ideally.15:12
Rocket2DMnOk15:12
philbullwe can replace it with several more focussed documents15:12
philbullat the moment, it tries to cover the needs of too many audiences at once15:12
philbullKelvinGardiner1: Making the guide more friendly is a major objective for the guide15:13
KelvinGardiner1ok15:14
philbullI've done a bit of research into the most common installation-related problems over the last few weeks15:14
philbullany guesses?15:14
DougieRichardsonIf anything, SFW should probably just be a FAQ covering common pitfalls.15:14
DougieRichardsonYes - formatting WIndows by mistake15:14
philbulllol15:15
Rocket2DMnvideo drivers, wireless cards, printers are common issues15:15
mdkethose are covered by the desktop documentation though15:16
philbullLots of people ask about installing from a flash drive15:16
philbullpartitioning, wubi, reinstalling Windows15:16
philbullquestions about resizing partitions, users worried about their data15:16
philbullwhether to go with 64-bit or 3215:17
philbullsystem requirements!15:17
philbullMost of these just aren't covered in the SFW guide15:17
philbullMy plan is to compile a list of the most common/important questions and cover those at appropriate stages throughout the guide15:18
philbullThe first section will be about getting Ubuntu (download ISO, ShipIt etc)15:19
philbullWhich installation methods to people think should be covered?15:20
philbulls/to/do15:20
DougieRichardsoncd, alternate and usb15:20
philbullwhat about wubi?15:20
KelvinGardiner1yes wubi.15:20
Rocket2DMnlivecd, alternate cd, wubi, flash drive15:21
philbullthe problem is, I want to make the guide as short as possible15:21
DougieRichardsonimg as well - unr uses it15:21
Rocket2DMnwell, there is already documentation on Wubi, right?15:21
mdkeI don't think alternate should be covered, that's what the installation-guide document is for15:22
Rocket2DMnfair enough, i dont know if as many people have problems with the livecd as they used to15:23
philbullI think that we should cover the livecd in depth and mention the others briefly, perhaps without screenshots15:23
philbullat least, we should point to documentation covering the others15:23
KelvinGardiner1Will the guide be stand alone in case the user has no internet connection, or will it point to other resources?15:24
mdkeI think it's important to distinguish installation method from installation media15:24
mdkethe installation process is actually the same whether you install from a cd, a usb stick or another typo of flash drive, I think15:24
mdkethat might affect the structure of the guide15:25
philbullKelvinGardiner1: it should be standalone for the basic installation process, but anything else can be linked15:25
philbullmdke: if the installer is the same for the different methods, then all we need to do is provide two different sections on "Getting Ubuntu"15:26
mdkephilbull: that's the sort of thing I had in mind yeah15:26
philbullok, that sounds good15:28
philbullthe next thing I had in mind was a troubleshooting section at the back15:28
philbullit would cover common or scary problems15:28
philbulle.g. "GRUB gives an error message!" or "I have a blank screen"15:28
philbullany thoughts on this?15:30
philbullagain, it would have to be kept quite short15:30
mdkesounds good to me15:30
KelvinGardiner1This sounds sensible. Key thing is to get the machine to boot and get an internet connection. Then for other issues we can point to the wiki.15:31
philbullI think it's important to decide on what should and shouldn't be covered15:32
philbullI think we should decide on a preliminary list on the mailing list, perhaps15:32
mdkepossibly the way to look at that is to do a survey about common problems with installation in the community15:33
philbull(BTW, the great thing about this guide is that it's going to be pretty modular, so lots of people can work on it at once)15:33
philbullmdke: I've been analysing IRC logs to find out what people are asking about the most15:33
mdkenice15:34
philbullthe most common "technical" problems seem to be GRUB errors and busybox/initramfs messages15:35
philbulllots about the CD not booting, too15:35
mdkeyeah15:35
DougieRichardsonLooking on the forums since Jaunty's release, repairing grub and partitioning seem to be prevalent15:35
mdkethose are often caused by bad burns or downloads15:35
mdkeso I guess md5sum and the cd check will come into that15:36
philbullMy idea for the format of the troubleshooting sections is something like a short Microsoft KnowledgeBase article15:36
philbullself-contained, text-only, references to related info15:37
DougieRichardsonFantastic15:37
philbullhttp://support.microsoft.com/kb/31006415:37
philbull(maybe a bit friendlier than that, though)15:38
KelvinGardiner1sounds good15:38
philbullThe only other thoughts on the structure of the guide I have is that there should be a decent index15:38
philbulland that we should have a short "What Next?" section after the installation has completed15:39
philbull(Kelvin, I think you suggested this)15:40
mdkesomething that links on to our other documentation, maybe15:40
KelvinGardiner1yes, I think this would be helpful.15:40
philbullmdke: The "What Next" section would probably just point to the "New to Ubuntu?" section of the system docs15:40
* mdke nods15:40
philbullSomeone will need to work on improving this too. It's not great at the moment15:40
mdkemaybe also introduce the answers to the the issues Rocket2DMn mentioned earlier, like hardware and internet15:41
mdkeby pointing to those docs15:41
philbullperhaps those could be mentioned in a troubleshooting article, e.g. "My hardware doesn't work"15:41
philbullConcerning the index, how translatable will that be?15:42
DougieRichardsonThere are already troubleshooting parts of the Internet section, can't we xref to them?15:42
philbullDougieRichardson: ideally, the guide will be self contained15:42
DougieRichardsonphilbull: does that mean we can't have it pull information from other areas rather than have to have two similar documents to update?15:43
philbullah, no, that should be fine15:43
philbullthere shouldn't be much overlap anyway15:44
philbullif we can point people at the system docs, then we should15:44
DougieRichardsonI'd have thought there would have been with Internet - especially wireless and modems.15:44
philbullthe troubleshooting should focus on problems where the user won;t have access to the system docs15:45
philbullif the user can open Yelp, then we should just point at that15:45
DougieRichardsonok.15:46
philbullNext, the delivery format15:46
philbullI was thinking: downloadable PDF, so the user can print it15:46
philbullHTML on h.u.c15:46
philbullmaybe on the LiveCD as part of the system docs?15:47
DougieRichardsonThe only problem with PDF is that they tend to get passed around rather than the link to their download which makes maintenance harder.15:47
DougieRichardsonThat said, the individual solutions like MS KB articles would be suited to a PDF15:48
KelvinGardiner1It would be nice to have a link on the desktop of the LiveCD to the guide. So its easy to find.15:48
philbullI definitely want to get it linked to from the download page15:48
Rocket2DMnDougieRichardson, your point about getting passed around is well taken, but isn't there advantage to that as well?  LIke passing around install guides at a LoCo meeting?15:48
DougieRichardsonRocket2DMn: Not if there are changes between releases, then we lose flexibilty in changing them.15:49
mdkeall those delivery methods are sensible, i think15:49
Rocket2DMnyeah, but the document is going to be geared toward a specific release.  And actually, not much changes with the install process15:50
mdkephilbull: on your translation question, I'm fairly sure that as long as the index is done using usual docbook tags, it will be translatable15:50
DougieRichardsonRocket2DMn: If it's single sheets addressing issues then that's cool but an entire installation document, I'm not so sure15:50
mdkeI think since we provide the serverguide in PDF form, there's no reason not to provide this by way of pdf either, especially if it i a self-contained document15:51
philbullmdke: I'll experiment with it15:51
philbullnothing worse than an index which isn't in alphabetical order!15:52
philbullOK, I'm pretty happy with most of this15:52
philbullAny general comments? Anything we've missed?15:52
mdkewhere will it be developed?15:53
philbullI want to do all of the writing before we do any markup15:53
philbullI guess that the wiki is the best place for that15:54
mdkeso are you going to work directly on the existing wiki Installation pages, or separately?15:54
philbullno, we'll draft it on wiki.ubuntu.com15:55
mdkehow would you envisage the finished guide interacting with the existing Installation pages on the help wiki?15:55
DougieRichardsonGoing back to the PDF thing and what Rocket2DMn said, it would be a good idea to have a single sheet covering installation with a FAQ covering common pitfalls on the back to hand out at LoCo meetings.15:56
philbullmdke: the existing stuff should redirect to the appropriate section of the official guide if that makes sense15:57
philbullwe can take lots of material from those pages anyway, I think15:57
mdkegood stuff15:57
philbullAha! License!15:57
philbullCC-SA?15:57
philbullDougieRichardson: that's a good idea15:58
DougieRichardsonWhy CC-SA and not CC-NC-SA15:58
mdkeeasy answer - nc is not a free licence15:58
philbullThe wiki is CC-SA15:58
mdkeand we use free licences15:58
mdkebut yeah, there's no real choice in the matter if material from the wiki is to be used15:59
DougieRichardsonSo using CC-SA, this can be packaged as a book and sold?15:59
mdkesure15:59
mdkelike any of our other material15:59
DougieRichardsonWhy is NC not considered a free licence?16:00
mdkebecause it prevents redistribution for a fee16:00
DougieRichardsonhmmm16:01
philbullOK, last thing I want to cover is how to proceed with writing the guide16:03
philbullwho wants to work on what?16:03
DougieRichardsonI'm not sure of the structure, so I couldn't say.16:04
philbullthere's the introductory bit, the bit on "getting ubuntu", the actual installation process and then lots of troubleshooting bits (we need to decide on what to cover in this section first)16:05
philbullplus, improving "New to Ubuntu?"16:05
DougieRichardsonWhy not put up a list on a wiki page and people can assign themselves to sections to deconflict?16:06
philbullthat works for me16:06
KelvinGardiner1ok16:06
philbullthere are also roles for people who want to research common problems, test the guide and produce screenshots16:06
DougieRichardsonI'll trawl the forum/net for common problems16:07
philbullI'll put my list of problems from IRC on the ml16:07
DougieRichardsonLets just consolidate the whole lot on wiki and reconveen next weekend with our thoughts?16:08
KelvinGardiner1At the start of the trouble shooting section there should be a list of links to laptop specific wiki pages e.g. eeepc macbook.16:08
philbullDougieRichardson: sounds good to me16:08
KelvinGardiner1DougieRichardson: I'm happy with that.16:08
philbullKelvinGardiner1: that's a good idea. If you have ideas for what might make a good troubleshooting topic, please add it to the spec:16:09
philbullhttps://wiki.ubuntu.com/Specs/KarmicInstallationGuide16:09
DougieRichardsonI'm not trying to be negative BTW its just with OpenWeek, Uni assignments and writing the UNR branch I'm finding it difficult to stay on top so the wiki works for me16:10
philbullDougieRichardson: that's fine, we have ages to work on this16:10
DougieRichardsonphilbull: cool16:11
philbullI won't have much time in the next couple of months myself16:11
DougieRichardsonI don't want to leave anything that's longer than six months either because I'm "on holiday" for four months later this year.16:11
philbullIt won't be that long, I want to get this ready for Karmic16:12
DougieRichardsonOh OK16:12
philbullOK guys, thanks for turning up16:13
philbullI'll start a couple of topics on the mailing list later today16:13
mdkethanks philbull16:13
DougieRichardsonThanks phil, mdke are you hanging about? I wanted to have a quick chat about OpenWeek16:14
KelvinGardiner1Will we meet next week?16:14
philbullKelvinGardiner1: yes, we can do16:14
DougieRichardsonphilbull: same time same bat-channel?16:15
philbullmaybe later in the day, I'm not home til Sunday evening next week16:15
DougieRichardsonok, then after 1900 is best for me16:16
philbullthat should be OK by me16:16
KelvinGardiner1works for me.16:16
DougieRichardsonCool, lets put it on the wiki with everything else and I'll see you all then16:16
mdkeDougieRichardson: go ahead16:16
philbullOK, thanks guys16:17
philbullI'll be in touch later today16:17
philbull(on the ml)16:17
philbullKelvinGardiner1: are you subscribed to the ubuntu-doc mailing list?16:17
KelvinGardiner1I've just done that.16:17
DougieRichardsonmdke: I just want to deconflict with what's needed to be said in the intro and the other sessions16:18
philbullok, cool16:18
DougieRichardsonmdke: two minutes while i put in the yorkshires16:20
mdkeDougieRichardson: yeah, that's a good idea. I think the sessions will inevitably overlap, but the key is that the first session is only introductory so doesn't go into too many details16:20
KelvinGardiner1ok, see you guys next week.16:20
DougieRichardsonmdke: right I'm back, I was planning an introduction to the documentation - system and wiki, difference between community and team wikis - structure (currently) and the recent proposals16:23
mdkeDougieRichardson: that sounds good. We already have some notes from a few years ago here - https://wiki.ubuntu.com/DocumentationTeam/OpenWeekNotes - those could be updated16:25
mdkethey are very old, but maybe useful16:25
DougieRichardsonyes and I've last times disaster to avoid, lol https://wiki.ubuntu.com/MeetingLogs/openweekintrepid/ContributeDocs16:25
mdkethat looks helpful too16:26
mdkebut probably editing the documents doesn't need direct coverage, as we'll deal with it in the later sessions16:26
DougieRichardsonOK I was about to ask if that was to be covered in Emma's docbook session16:27
mdkeright16:27
DougieRichardsonOK, so I've an idea where I'm going, I'll mail you my outlined notes tonight (once I've written them)16:28
mdkeawesome, maybe stick them on the wiki for group review16:28
DougieRichardsonWhat time frame are we talking, I thought 40 minutes tutorial to 15 minutes of q&a16:29
mdkesounds spot on to me16:29
DougieRichardsonCool16:29
DougieRichardsonOK well, I'm happy then, I'll drop a line later - cheers16:29
mdkecheers16:29
DougieRichardsonthanks16:30

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