Posted by chrisshattuck on August 29, 2010 at 10:55pm
Jump to:
| Project: | Documentation |
| Component: | Correction/Clarification |
| Category: | task |
| Priority: | normal |
| Assigned: | lisarex |
| Status: | closed (fixed) |
| Issue tags: | distributions |
Issue Summary
Judging from this page about the NodeStream distribution, it looks like there's not a good place yet for documentation on distributions. The NodeStream docs are in the Tutorials section, but this doesn't quite seem right. I might be adding some new docs on another distribution, and I'm wondering if there should be a new handbook specifically for distribution documentation. Thoughts?
Thanks!
Chris
Comments
#1
There's some information already at http://drupal.org/node/326175 as well that lists some Distributions, but that definitely doesn't look like the best place to put documentation on specific distributions, either. Perhaps it's time for another section?
#2
Good call. New sections could be added under the Distributions section for each distribution. So, do folks think this would be preferable to adding a new handbook?
#3
Hey Chris -
Huh, sneaky issue here, I'm not 100% sure what's up with distro docs. For now I'd propose that we actually start listing specific distros and related info as a book section below http://drupal.org/node/326175. And that the Nodestream pages http://drupal.org/node/892734 should be moved in there as well (they don't really belong in the Tutorials section).
If you want to add your page(s) in that section, post here and let me know when you have, and I'll move the other stuff and notify the author that's been done.
This should accommodate better as info on distros grows, which I can see happening pretty quickly. Then if the info on Distros needs to be moved somewhere better, at least it will all be in one place.
Thanks!
#4
Thanks for weighing in, Ariane. I guess the nice thing about the book pages is that they can be re-organized later. For now, it seems like putting them as sub-pages of http://drupal.org/node/326175 is a good idea. And in the future, maybe it can be promoted to its own handbook page if it seems like a good fit.
Cheers!
#5
Welcome! Indeed - I'm going to set this to postponed, and please reopen it once you've added your pages, then I'll get my hands dirty and move some things around.
#6
note: ProsePoint, DrupalCampLA, UberDrupal, ManagingNews, OpenPublish, Drupal Commons need adding, as noted in http://drupal.org/node/896582 (duplicate)
#7
I don't know if I'll be posting docs to this area or not anytime soon, so if you or anyone else need to make adjustments (or if someone else does), please feel free to go ahead.
Thanks!
#8
roger.
#9
adding tags
#10
I don't think Distributions belong in a section called Third-Party resources... right now, a Distributions section in the Site Building Guide makes the most sense to me, or just create a separate book for Distributions.
I have the COD documentation (http://drupal.org/documentation/build/cod) in Dates and Events section of the Site Building Guide because that seemed most relevant. The COD documentation is a bit light at the moment, but will grow a lot. I will definitely be linking out to other module docs (e.g. UberCart). That means that users will be bounced all over the place until #995370: Want the ability to create multiple outlines/maps can be implemented :/
Regardless of where each set of distro docs lives (e.g. Open Atrium is not on d.o.), it would be useful to have all the Distributions and links to their documentation in one list on d.o..
#11
I'm wondering where to place docs for Build Kit, a starter distribution.
#12
I think section for Distributions documentation in the Site Building guide would make sense - and a page about getting a distribution in the Installation guide would also be appropriate.
#13
I concur - Site building guide sounds like a totally reasonable place. Shall we get a section for Distros going there? It's only going to grow as time goes on so we ought to make it as flexible as possible. (And agree with Silverwing, we should mention and link over from the Install guide.)
Then langworthy can move the buildkit docs in there.
#14
I've created it here, and moved a couple set of distribution docs over
http://drupal.org/documentation/build/distributions
But, if we add in the off-site stuff,it'll push the the linked docs further down, I'm creating a separate page for the offsite docs, but referencing them on the main page
Not entirely sure what to do with the content on http://drupal.org/node/326175 but I suppose this page shouldn't remain here at all, since it's not third-party
#15
I think http://drupal.org/documentation/build/distributions should be for on-site documentation and links to off-site documentation, along the way it's been started. Perhaps the off-site documentation links should be alphabetically listed to avoid any bias.
http://drupal.org/node/326175 should be a common place for listing actively maintained distributions, with a brief "sales" , much like it is. Since it is listed under 3rd party resources, it makes sense for people just looking for whether a distribution for their use case. It beats the list of 170 installation profiles that are listed, which, if nothing else the formating makes it hard to decide what is what.
#16
I like that this has been built out but the problem is that the onsite documentation is a lot harder to find.
Two choices:
1) Include onsite documentation in this table
2) Move offsite documentation table to http://drupal.org/node/1085574
(Also I noticed the PressFlow documentation still needs adding etc.)
#17
Just reviewing all this -
I agree that http://drupal.org/documentation/build/distributions should be for onsite documentation about what distros are and how to use them.
http://drupal.org/node/1085574 is a good place for offsite docs, and I agree it can be separate.
But http://drupal.org/node/326175 I think *should* move out of the 3rd party resources area and into the distro section - I think it's really important that any distro focused pages are in the distro section so people will find related docs pages within the single section of the book outline.
#18
OK, I've moved that table to the "Additional" page.
But http://drupal.org/node/326175 I unpublished and I think it should be deleted. It's 95% redundant information. I think we've got good info here: http://drupal.org/project/installation%20profiles, here http://drupal.org/node/306267 and now http://drupal.org/documentation/build/distributions, though maybe they need a bit more work as well.
#19
looking really good!
- http://drupal.org/node/306267 could probably use a more obvious link back to the distros page (http://drupal.org/node/1085574)
- http://drupal.org/node/1089736 seems a little lost - seems like it should be moved into the distros section (?) probably into http://drupal.org/documentation/build/distributions as the first page within this section.
#20
Thx Ariane! I've made those changes you suggested.
#21
Well, I think the initial point of this issue has been well taken care of at this point - I'm going to mark fixed! Thanks everyone!
#22
Automatically closed -- issue fixed for 2 weeks with no activity.