=== warthylog [~warthylog@port49.ds1-van.adsl.cybercity.dk] has joined #ubuntu-doc === Topic for #ubuntu-doc: Ubuntu Doc Team - general discussion - backlog at http://irclog.workaround.org | This channel tries to follow the tradition of the #gnome-love channel on irc.gimp.net, all new comers and questions are welcomed, as long as you follow the Ubuntu community code of conduct @ http://www.ubuntulinux.org/community/conduct first. === Topic (#ubuntu-doc): set by sivang at Sat Jan 1 20:48:30 2005 [08:59] (enrico/#ubuntu-doc) not really a vendor branch: during the docteam bof, jdub said that the Gnome people were working on making it easy to rebrand the Gnome User's Guide, so we could work with them on that [08:59] makes sense [08:59] Do you mind if I rename DocumentationTeamHome in DocumentationTeam? [09:00] Its up to you. I am not stuck on anything. Remain flexible [09:08] froud: BTW, I remember from a previous IRC log that you and plovs talked about adding authorblurb to book chapters, to mark that one's working on it. However, I didn't understand what was the agreement on that, so I coudln't cover it on the report [09:09] goals and responsabilities are not defined clearly [09:09] nobody knows who is doing what [09:09] in the docs I thought it woul dbe good for people to add their name next to sections they want to do [09:10] I would then use this to automatically make a list of what is in th epipe and what is not [09:10] this way new people can also see what they may do [09:10] I made a proposal in email [09:10] but only plovs responds [09:10] We could try to do some step-by-step pages on contributing: "how to write text" (add your name as authorblurb, write things, commit). "How to review" (read, post comments in the list, fix typos and commit, discuss bigger things in the list with the people in authorblurb) [09:11] sure, but thiss is a general wiki thing [09:11] we need traction on the docbook stuff [09:11] In general I am not happy with the spead of work [09:12] But at least it would allow people who want to contribute to just start doing along a clear path, without needing to figure out anything. [09:12] agreed [09:12] hence I was building from the inside out [09:12] If I'm lazy and I want to contribute, I'm happy to follow something step by step [09:12] but it needs for people to put their names in the source against sections they want to do [09:13] writin a step by step is good [09:13] and should be a goal [09:13] but all this detracts from Hoary [09:14] well, "add authourblurb like this" could be in the step-by-step [09:14] already I have spent more time Documenting the Documentation Project that I should [09:14] and with all the confusions on the current goals I have now focused on the admin guide [09:15] this because I can get traction [09:15] on most projects you just need the for the hasty [09:16] and peolple get stuck in [09:16] and discuss on mail [09:16] now discussion is good, but only if people do talk and respnd to one another [09:16] for example [09:17] it is frustrating spending an hour or more composing an RFC or Proposal to only get back one response [09:17] eventually I think [09:17] wtf [09:17] why waste my time [09:17] just do it and dont talk to anyone about what I am doing [09:18] but this is not healthy in OSS projects [09:18] excuse me if I am being a bit critical here [09:18] but I think it is required [09:19] without proposals/rfc's and responses of others opionions it is hard [09:19] to organize and mobilize [09:19] you're quite right. I think you're reasoning at a larger scale than the current docteam is: active people at the moment are roughly you, plovs, me, chrish, sivang (did I forget anyone?) [09:20] I have a long author group list [09:20] are they there? [09:20] or just to get their name on the page? [09:20] How long since their last commit? [09:20] Maybe they did something some time ago, and became inactive [09:20] just do svn log in th etrunk [09:21] if you want o see what people did then do svn blame on a folder [09:21] or file [09:21] Yes, I know subversion, but that was to tell you about what could be the real size of the team [09:22] well I/we cant mandate anything [09:22] but my point is people are not reponding on issues posted to the list [09:23] my guess on that is because we're quite a tiny team atm, and most of the people hang out on IRC anyway and have discussed such things on IRC with you [09:24] irc goes away [09:24] if they haven't, next time they come to IRC you can say "hey, have you read that? What do you think?" [09:24] email stays [09:24] I know IRC goes away (and with the reports I try to make the most important things stay, since more things happen in IRC than in the list) [09:24] point is email is a better log of what was decided to do [09:24] However, for smaller groups in which everyone hangs out in IRC, IRC can be the main mean of communication [09:25] Like "if froud didn't mention that on IRC, then he doesn't need further comments on the list" [09:25] I'm not saying that it's right, I'm guessing what's happening [09:25] enrico, most of the list irc list is comprise don bots and people who doint contribute [09:26] But all the 5 names I mentioned you before hang out on IRC [09:26] yes. they do [09:26] but I dont want to discuss long issues in irc [09:26] I use my email [09:27] I can always make messages important and search email [09:27] to remind me what exactly was said [09:27] I suggest you post things on the list, then ping people on IRC. If I don't see answers to my mails, I chase people on IRC: that's the only way I can have answers, I realized [09:27] sucks [09:27] I know, but I don't seem to be able to get things done otherwise :( [09:28] well I have decided that I am just going to hack on. So I may drop out of site [09:28] you will see my commits [09:28] I wont waste my time writing rfc or proposals [09:29] I write down things on a mail, then after one or two days I don't get an answer I go on IRC and I start "did you see my mail with subject "xxx" 2 days ago? when can we do that?" [09:29] yes we discussed that [09:29] my goal is hoary [09:29] and as I see it the date is 21 feb [09:30] I agree. It's time to hack. [09:30] I would so much prefer to be doing progress reports rather than tidying up proposals and consensuses [09:30] so if u dont see me on irc or on the list, just do svn log [09:30] well progress can only be obtained when people know and say what they are doing [09:31] :) But please stay around on IRC... that's comfortable if someone wants to contact you [09:31] And it's cool having you around here! [09:31] They can post to the list, perhaps that will force them to communicate [09:32] the problem is that there is no alignment [09:32] Another item for the "step by step": how to contact the others. Mail in the list, with a "if I don't see people disagreeing within 3 days, I'll go on" [09:32] what do you mean with alignment? [09:32] good, agreed [09:33] people need to take ownership and align on what they will do and on what they will help [09:33] for example [09:33] I may take sections about [09:33] DNS, TCP/IP [09:33] then I need people to review [09:33] if I know who will help [09:34] it would be easier [09:35] frankly I am pissed and that is the time when I normally just kickout. But I have committed to much to do that now so I must ride the wave. [09:35] I had a chat about this to mako [09:36] I understand the conditions [09:36] but must also decide whether this project is worth it or not [09:36] IMHO, since I started the Admin Guide I must follow through [09:36] and I intend to do that by hoary [09:37] I was innitially intending to help build processes etc. But see that this is not working [09:37] if it was making progress, I would continue [09:38] I'm sometimes pissed or sad to see that very few people are doing things. When it happens, I just restrict my notion of the team to the few that are making commits, and then I'm happy we have a tiny team of active people. Then I try to find out ways on how to get more people involved. [09:39] you have the time for that, :-) [09:40] Well, yes, that's also what I'm paid for. But it's interesting, nonetheless, to observe the dynamics of communities and see how things go [09:40] sure [09:40] The cool part is that I cannot judge things, as they just go regardless of my judgements. So I have a chance to see beyond the current understandings [09:41] Like, there may be few active people not because everyone's an asshole, but maybe because we don't advertise the project properly [09:41] And it may be that we don't advertise it properly because we have no easy and clear enough page to point people at [09:42] well, now we probably have some of such pages, so I'm considering advertising [09:42] The main problem with documentation iin OSS is that OSS projects do not understand that it is part of a "go-to-market" strategy. [09:42] I'm quite enthousiast by your recent work, and I'm very committed in merging in the old things and in makign the step by step pages, then pointing people at them [09:42] As you know there is very little go-to-market in OSS [09:43] this is why there are so few open source authors [09:43] the business case is easy to make for developers [09:43] but not so easy for writers [09:43] what do you mean with business case? [09:43] IMO, OSS projects should hire writers [09:43] developers, most of them [09:43] make money from services [09:44] support, training, implimentation [09:44] writers cant do that [09:44] the business case for developers has money behind it [09:44] good point [09:44] for writers it currently does not [09:44] that's why most writers are developers that need to document their thing [09:45] and developers cant write [09:45] and if they are paid to write [09:45] another class of writers, however, could be users that want to improve things for themselves [09:45] that time is not well spent [09:45] I'd like to try to give users a chance to do things [09:45] enrico, as you know it takes lots of time to write docs [09:46] properly [09:46] most people will not commit that amount of free time [09:46] I feel that OSS projects (large ones) [09:46] need a core paid team [09:47] the ensure progress [09:47] they [09:47] and accept contributions [09:48] As an author, I sometimes question the motives of OSS projects in expecting to get free documentation for something that is essentially a go-to-market strategy [09:49] go-to-market is a recent thing in the life of OSS [09:49] a few years ago it never existed [09:49] but in going to market, you need to build a complete project [09:49] and product [09:50] uhm uhm. Could it be that the wrong thing we're doing is trying to make books? I'll explain: [09:50] the software alone is not complete [09:50] ok [09:51] quality books need quality writers and quite some quality assurance chain; they also need deadlines (they should come together with the software) and they get obsolete as software progresses. This means that to have a quality book, a team must be paid regularly to create and update something within a given deadline [09:51] agreed [09:52] However, there are people writing small tutorials and HOWTOs all the time for various reasons; two that get to my mind are show off what they managed to get, explain something to someone and then share it to others [09:52] So, if we want to harness and structure these volunteer contributions, the book for doesn't capture these pieces of informations very well, as it would be a book that collects autonomous, unrelated pieces of information [09:53] But we don't necessarily need to make books, stealing professional writers their wage [09:53] agreed [09:54] So, I think at the QuickGuide: that's a collection of unrelated pieces of work, all different introductions to different applications. That could be workable. [09:54] disagree [09:54] Or another thing could be collecting all the HOWTOs that have been written in the Wiki and making a yelpable document out of them [09:55] part agree [09:55] Or packaging the HOWTOs and tutorials that we find around together with the application itself [09:55] disagree [09:55] Or similar other creative ways of taking what people like to write on their own and seeing if something cool can be done with that [09:56] what is the ultimate objective of Ubuntu? [09:56] total world domination as usual, I guess? Solving bug #1 in bugzilla? === ChrisH [~chaas@gw.workaround.org] has joined #ubuntu-doc === boglot [~logbot@gw.workaround.org] has joined #ubuntu-doc [09:56] not possible [09:57] hello ChrisH! [09:57] froud: what do you mean? [09:57] hello ChrisH [09:57] world domination is not possible in OSS [09:57] the fabric of OSS ensures this [09:57] So what is the ultimate objective of Ubuntu? [09:58] Sure, I was joking on that. I think the goal is making a substainable company that pays developers to improve the world of free software in a way or another [09:58] *developers* [09:58] I think I get what you mean. Not only developers are required to improve the free software world, right? [09:59] The ultimate objective of ubuntu is to create a revenue stream fro Canonical Ltd. [09:59] In 2 minutes I need to pick up the laundry, staying afk for around 5 minutes. [10:00] ok [10:00] yes, sustainable company means revenue stream [10:00] Mark Shuttleworth is not stupid [10:00] he knows that OSS is the ceapest way to develop sofwtare [10:01] Canonical makes money by probviding services around Ubuntu [10:01] at present the business in sponsoring (investing) [10:01] the business plan is long [10:01] a number of years [10:02] Thi si sfine [10:02] but to build a platform that "Just works" [10:02] requires quality [10:02] ateention to usability [10:02] training [10:02] support [10:03] docs are about knowledge transfer, they are the first line of support === enrico nods [10:03] most 'users' dont understand HOWTO's [10:03] actually quality and usabilty are the even firster lines of support [10:03] they dont understand developer docs [10:03] yes, integral to the product [10:03] to create a complete product you need it all [10:04] you need Certification [10:04] training engineers [10:04] trained trainers [10:04] only then will large business adopt [10:04] SuSE/Novell has this right [10:05] RedHat is doing the same [10:05] Yes but with Novell enterprises have local support from the mother company [10:05] they have trained engineers that are allocated to solve the problems of the large businesses they support [10:05] try live in South africa and get support from RH [10:06] you cant [10:06] Maybe RH doesn't target SA. I know they do this with US and at least some of the EU [10:06] But yes, I see the point [10:06] For ubuntu to succeed [10:06] I've started telling people that the best way to help free software is start a company and make money doing support [10:06] it needs to build a complete project [10:07] a complete product [10:07] ok so how do writers make money [10:07] we have to live [10:08] Either you work on your own, or you are hired by someone [10:08] If you work on your own, you create a product and then get money from your target to make it evolve [10:08] people open support companies and have a first line of support in the docs, can I get a royalty [10:09] not likely [10:09] ok so as a writer, what would your product be to achieve that objective [10:10] a book, an interactive cdrom, an expert system, some useful piece of documentation [10:10] ok but then I will not OSS that [10:10] if I do it is free to use by all [10:11] You can OSS it and still get money to support it, or customize it to local needs [10:11] where's the money? [10:11] everybody can do that [10:11] why do they need me [10:11] Like, get paid to extend your OOo guide to cover the local needs of an enterprise, by going there and study how they work [10:11] everybody can do that with software, too [10:11] the whol epoint of OSS is that they can get the source [10:12] yes, they can [10:12] but everybody thinks they are a writer [10:12] not everybody thinks they are a dev [10:12] or can impliemnt [10:12] oh, if you look at PHP software repositories you'll find lots of people thinks they are a dev [10:13] or look at ASP e-commerce solutions [10:13] sure and what do you get [10:13] poor quality [10:13] If I understand this right, there must have been a reason for Mark Shuttleworth to want to build ubuntu [10:14] why not just take an existing distro [10:14] why do we need a new distro [10:14] what distro would you have taken? [10:14] laundry, bbiab [10:14] well mandrake is doing a good desktop job [10:14] ok bye [10:15] But mandrake's not Debian [10:15] does that really matter [10:15] Appearently, it does [10:15] the users dont care [10:15] Maybe just as a quirk from Mark [10:15] why go to all the trouble [10:16] I dont think it is a quirk [10:16] Maybe because Debian was potentially much better and only needed that small bit of a cleaning [10:16] a person that has "There be dragons" written on his web site has done shome serious thinking and reading [10:17] no there be money here [10:17] Canonical wants a quality product [10:17] they call there own [10:17] if they took just another distro [10:17] they would just be a shop [10:18] well to be continued perhaps [10:25] I"m back [10:26] geeze that was quick [10:26] you have a laundromat next door? [10:26] laundry here is hung in bamboo sticks: you put the basket on the ground, pull down the stick, shake it and everything falls on the basket :) [10:27] cool [10:28] well, I am going back to respond to your messages and then hack the admin guide. [10:28] just wish svn was not down, again [10:28] is it down? bu [10:29] Tuesday I'll hear from Elmo again. Yesterday I gave him a dump and some hooks so that he can play around with subversion server-side [10:29] hmm, you try maybe its just the connectivity from South AFrica [10:30] yes, saw that message sounds good [10:30] svn works now [10:30] just tried an update [10:30] may be it is just the connectivity from here [10:31] oh hold on here it is :-) [10:39] froud: can I take the Docbook 4.3 item away from DocteamWishlist? (or move it to a solved part) ? [10:39] sure, we have all 4.3 now [10:42] froud: moved. Thanks! [11:00] froud: I merged the descriptions from the FAQ into DocteamProjects [11:01] looking [11:02] I'm adding a desc of the AdminGuide [11:02] done [11:05] enrico, nice, I see a few touches needed in text, but will do those [11:06] what about the internationalization? [11:06] <_d4vid> hi all [11:07] hello _d4vid [11:07] enrico, why do we duplicate content under the FAQ? [11:08] tis better to link between the pages [11:08] e.g. What is being worked on? [11:09] I wanted to put something just to avoid the frustration of finding a link but not an answer; however with this question you convinced me to just list the names of the things and link to DocteamProjects. I'm doing it now... [11:14] done [11:18] much better :-) [11:18] always easier to maintain in one place and link to it in various contexts [11:19] enrico, do we really want to port GNOME documentation [11:22] That'd be important afaik, since ubuntu would be one of the main distros featuring gnome [11:23] yes but why port [11:23] *port* [11:25] Seems to me, GOME has a code base [11:25] we should reuse it [11:25] Port does not make much sense, yes. Rebrand does [11:25] Ubuntu doesn't make many modifications to Gnome anyway [11:25] to accelerate doc dev [11:25] we should consider a process akin to vendor drops [11:26] however, mako and others have said that there are problems with vendor drops [11:26] I plan to test it locally [11:26] GNOME is in CVS [11:26] we're in SVN [11:26] that further compunds things [11:27] but I see they have svn_load_dirs.pl [11:27] this could solve much of the overhead [11:29] the alternative is to maintain symlink to a local co on each authors host [11:29] No, please... I suggest you ask jdub about the rebranding support they want to build into gnome docs upstream, and we work with them [11:29] yes we can do the same from our repos [11:29] fact is everything ubuntu docs related can take place upstream [11:30] what's left [11:30] one must seriously ask the question, "Do we need core docs?" [11:31] As I see it, we do need the About Ubuntu page, the Quick Guide and the rebranding of the Gnome User's Guide [11:31] Those don't exist upstream or require us to work with upstraem [11:32] I don't say anything about the User's Guide and the Admin Guide, because they came out spontaneously [11:32] Yes [11:33] Same as the FAQ Guide. But the FAQ Guide has been finished, it's cool, wow! [11:33] The only value in having our own versions is if we have a difference between ubuntu and upstream [11:33] thanks to plovs [11:34] The about ubuntu page has been "finished", but still misses a make target that generates it [11:34] yes, I have this as a bug [11:35] So, for what hoary is concerned, we miss the Quick Guide [11:37] yes, but much of quick guide stuff can be reused form GNOME [11:38] Can you give me an example in Gnome? [11:39] well as I understand QG, its a short intro to the app and a screen capture [11:39] this exists in all GMOME docs [11:40] Could you give me a link? [11:41] in cvs? [11:42] don't they have them in the web? [11:44] yes, but I never look at it [11:44] :-) [11:44] just the code ? [11:46] grrrr. never can find anything on GNOME site [11:49] enrico, the other way is to use the docs from the app source like GAIM [11:49] but that means many vendor drops [11:50] Do you have a CVS example, then? [11:50] hold getting it [11:51] I'd like to look at it to see if they are already doing a short useful self-contained description: I'm used at seeing introductions to further text rather than small, self-contained intros. [11:52] here is a generic example from their tutorial src [11:52] [11:52] About this Document and gdp-example2 [11:52] [11:52] ScrollKeeper [11:52] Examples [11:52] gdp-example2 [11:52] [11:52] [11:52] The package gdp-example2 illustrates how [11:52] to set up a GNOME 2 package to properly install its documentation and OMF [11:52] files and register them with ScrollKeeper. This document is part [11:52] of the gdp-example2 package and explains what the [11:52] important files in the package are. This document also provides [11:52] step-by-step instructions on how to modify an existing package to include [11:52] the documentation files and build instructions. [11:52] [11:52] [11:52] That this document is meant to be a brief explanation and tutorial [11:52] on what needs to be done. For more information, look inside the [11:52] various files in this package or contact the authors. [11:52] [11:52] [11:52] This package is maintained in url="http://www.gnome.org/">GNOME CVS for [11:53] in the class="directory">gnome-docu module under [11:53] gnome-docu/gdp/. === enrico hopes froud isn't pasting it all [11:53] [11:53] [11:53] you want to use pastebin [11:54] pastebin? [11:54] Anyway, from that intro, that document is a bit too much. [11:54] (it seems to me) [11:55] The quick guide shouldn't really spend too much time teaching how to use things. More like telling what could be done with things. [11:55] yes, but you can get only what you need [11:55] Maybe I should write a page as an example [11:55] that would be good [11:56] The other question is: is it simpler to pull in all the bits we need or to just write? [11:56] from a maintenance perspective it is better to use a vendor drop [11:57] I imagine the QuickGuide would be rewritten in most parts for every Ubuntu release [11:58] sure that's why you want to reuse [11:58] froud: [different topic] Since every product page (AboutUbuntuPage, QuickGuide and so on) has a status section, do we really need DocteamStatus? I was considering aggregating it with DocteamProjects, saying that the link also contains status info [12:00] each doc has a revisionhistory [12:00] no status [12:00] but that revision history is not the same as status [12:01] over at GNOME they maintain a document owner list [12:01] and KDE to [12:01] I try to explain myself better: http://www.ubuntulinux.org/wiki/QuickGuide has a "Status" section, and DocteamStatus claims to be linking to just that [12:02] There is too much in that spec [12:02] http://www.ubuntulinux.org/wiki/FAQGuide has a better status section [12:02] http://www.ubuntulinux.org/wiki/AboutUbuntuPage even better [12:02] also to much [12:02] there is not much in QuickGuide because not much work in it has taken place yet :) [12:03] why have the outline there [12:03] No reason to have hte outline, can be fixed, but [12:03] doc spec is short to the point === enrico points froud to the "status" section :) [12:03] status is something long [12:03] each section has a staus [12:03] uhm... who would maintain that? [12:03] and that is agregated to give the overall stat [12:04] automatic if you read the message I sent. I will expand on it in a response [12:04] Unless it could be autogenerated from docbook tags and svn commits, I see problems in maintaining tags by hand [12:04] Ok, I'll wait for the response then [12:04] I have a meeting now. must go [12:05] dinnertime here. brb [12:31] Busy evening is going to be. I'll resume works tomorrow. Tomorrow I'll be working on Ubuntu the whole day [12:31] Bye! === [froud] [~sean@ndn-165-141-101.telkomadsl.co.za] has joined #ubuntu-doc === abelli [~abelli@84.222.39.195] has joined #ubuntu-doc === douglas [~douglas@200.149.180.237] has joined #ubuntu-doc === [froud] is now known as froud [07:59] <_d4vid> play HIM - You Are the One.mp3