|
osdir.com mailing list archive |
|
Subject: Re: opml vs weboutliner? - msg#00311List: php.drupal.documentation> > actually > > work for docs sync. > > > > > Why do we want to have synchronization? Let's say CivicSpace write or update docs regularly, which they want included in the handbook. They are trusted to do a good job. It takes time to mass update. Sync the relevant parts between Drupal and CivivSpace is how I call that. All of the talk about mass updates, outlines, etc... > Ok, wait, I see, because you have downloaded the book. > Hm, well, I guess we control it on this site to prevent two people > editing the same page at the same time. The bigger question is what do we control? Content and its structure, I suppose. But structure should reflect the particular audience. CivicSpace or Drupal? How do you map between those - to save the effort of the writers - they are better at creating rather than pasting. It can become frustrating after some time. > > I would say - help with introducing structure, and fixate > > only the really stable bits. This will produce a skeleton and > > a lot of feathers around it. But it will be helpful. > > > I don't think I understand this comment... though, admittedly, it > wasn't aimed at me. ^.^ What would be the skeleton and what would be > the feathers? An attempt at 'poetic' metaphors *g* The skeleton is the handbook - tight, rarely changed content. Feathers - everything else, i.e suggested improvements, external articles, etc... Some of those considered useful, can enter the handbook after some time. Thread at a glance:
Previous Message by Date: click to view message previewStylesheetThis is just a suggestion for how a page might go... feel free to comment change whatever. The end result should be something we can keep consistent across all handbook pages and is useful/understandable to the end user. ======================= Modules >> Installation Target: This page is aimed at anyone who is running a Drupal site (Drupal site admins), who has downloaded a module and wants to install it. Topics covered: How to install a module. You need to know: How to open a tarball, how to upload files to your Drupal site (either by FTP or...whatever else there is ;p) Related topics: How to make a module, uninstalling a module, themeing a module. Background information: Blah blah as short and blessedly brief as possible. Step by step instructions. 1. This is a sentence. Screenshots and example code should be included as much as possible. 2. This is a techy word: XKLJHIUYS (should include link to glossary entry) 3... Troubleshooting/common questions: I don't see my module in the module list, Error: invalid xyz, Can't open install file, how to make my module the front page? Other sources of help: Link to any available videos, alternative documentation. ======================================== Criticism welcome. My feelings won't be hurt. ;) By the way, why does marking something as code reduce the font to that horrible to read size? It's like half normal text. Anisa. Next Message by Date: click to view message previewRe: opml vs weboutliner?This is a multi-part message in MIME format. Vladimir Zlatanov wrote: Well, not the only one, I have big reservations that OPML and similar will actually work for docs sync. Why do we want to have synchronization? Let's say CivicSpace write or update docs regularly, which they want included in the handbook. They are trusted to do a good job. It takes time to mass update. Sync the relevant parts between Drupal and CivivSpace is how I call that. All of the talk about mass updates, outlines, etc... hm... CivicSpace documentation... Alright. I can see this working if, let's say, we let CivicSpace doc people handle the CivicSpace *specific* information. Wherever that differs from Drupal info, we have a link (civic space users, see this....). Maybe there is a book, or a branch in a book that deals with CivicSpace specific details we can link to. Ok, wait, I see, because you have downloaded the book. Hm, well, I guess we control it on this site to prevent two people editing the same page at the same time. The bigger question is what do we control? Content and its structure, I suppose. But structure should reflect the particular audience. CivicSpace or Drupal? How do you map between those - to save the effort of the writers - they are better at creating rather than pasting. It can become frustrating after some time. bah, anyone can hit ctrl+v. Drupal is the base, and the handbook is hosted on Drupal. Documentation cannot be merged. What do the CivicSpace people want to do? only the really stable bits. This will produce a skeleton and a lot of feathers around it. But it will be helpful. I don't think I understand this comment... though, admittedly, it wasn't aimed at me. ^.^ What would be the skeleton and what would be the feathers? An attempt at 'poetic' metaphors *g* The skeleton is the handbook - tight, rarely changed content. Feathers - everything else, i.e suggested improvements, external articles, etc... Some of those considered useful, can enter the handbook after some time. Due to Drupal's no backwards compatibility policy, some things will change every reiteration. I had not thought of Civic Space. Must think some more. What about Bryght? Anisa. Previous Message by Thread: click to view message previewRe: opml vs weboutliner?This is a multi-part message in MIME format. Vladimir Zlatanov wrote: OK. So we drop that. Well, I wouldn't drop it /that/ quickly <g>. If I'm the only one who's against it, then I should be heartily ignored or forced to defend. Well, not the only one, I have big reservations that OPML and similar will actually work for docs sync. Why do we want to have synchronization? Ok, wait, I see, because you have downloaded the book. Hm, well, I guess we control it on this site to prevent two people editing the same page at the same time. I would say - help with introducing structure, and fixate only the really stable bits. This will produce a skeleton and a lot of feathers around it. But it will be helpful. I don't think I understand this comment... though, admittedly, it wasn't aimed at me. ^.^ What would be the skeleton and what would be the feathers? Anisa. Next Message by Thread: click to view message previewRe: opml vs weboutliner?This is a multi-part message in MIME format. Vladimir Zlatanov wrote: Well, not the only one, I have big reservations that OPML and similar will actually work for docs sync. Why do we want to have synchronization? Let's say CivicSpace write or update docs regularly, which they want included in the handbook. They are trusted to do a good job. It takes time to mass update. Sync the relevant parts between Drupal and CivivSpace is how I call that. All of the talk about mass updates, outlines, etc... hm... CivicSpace documentation... Alright. I can see this working if, let's say, we let CivicSpace doc people handle the CivicSpace *specific* information. Wherever that differs from Drupal info, we have a link (civic space users, see this....). Maybe there is a book, or a branch in a book that deals with CivicSpace specific details we can link to. Ok, wait, I see, because you have downloaded the book. Hm, well, I guess we control it on this site to prevent two people editing the same page at the same time. The bigger question is what do we control? Content and its structure, I suppose. But structure should reflect the particular audience. CivicSpace or Drupal? How do you map between those - to save the effort of the writers - they are better at creating rather than pasting. It can become frustrating after some time. bah, anyone can hit ctrl+v. Drupal is the base, and the handbook is hosted on Drupal. Documentation cannot be merged. What do the CivicSpace people want to do? only the really stable bits. This will produce a skeleton and a lot of feathers around it. But it will be helpful. I don't think I understand this comment... though, admittedly, it wasn't aimed at me. ^.^ What would be the skeleton and what would be the feathers? An attempt at 'poetic' metaphors *g* The skeleton is the handbook - tight, rarely changed content. Feathers - everything else, i.e suggested improvements, external articles, etc... Some of those considered useful, can enter the handbook after some time. Due to Drupal's no backwards compatibility policy, some things will change every reiteration. I had not thought of Civic Space. Must think some more. What about Bryght? Anisa. Loading Comments...
|
|
