Is there a central place for Documentation of the BOA project?

Events happening in the community are now at Drupal community events on www.drupal.org.
tribe_of_dan's picture

Comments

I should also mention the old

tribe_of_dan's picture

I should also mention the old issue queue: https://github.com/omega8cc/nginx-for-drupal/issues

Well, one of the main reasons

omega8cc's picture

Well, one of the main reasons why BOA was created in the first place, was to give people a tool, simple enough, so no docs should be needed :)

Of course there are always some things you can't avoid, like configuration options, best practices or troubleshooting.

I strongly believe in KISS rule, so I don't want to multiply or copy the same things in various places.

Currently the 'canonical' place to start when you feel you need docs, is the project README and docs/* files, linked also from the project pages on d.o. From there you are directed to read also configuration comments in all scripts, and that should be enough to use the BOA system.

If you want to learn more, we started publishing some related articles at http://omega8.cc library, but for community powered docs I think we could use wiki pages here, in the BOA group on g.d.o, to keep everything in the same place and avoid adding any confusion about where is that 'canonical' place to start.

Some BOA users already proposed in the past to create dedicated website, like c.a.o for Aegir, but I don't support this idea. We don't need any further fragmentation of the community, we should stay at c.a.o, g.d.o and d.o if possible, and always separate discussions, issues and docs/wiki to minimize possible confusion for new users.

If you want to start or help with community powered docs, please create wiki pages here in our group.

Thanks Grace, though I don't

tribe_of_dan's picture

Thanks Grace, though I don't feel like any form of expoert but I've started a wiki page: http://groups.drupal.org/node/163784

I've tried to link to as much existing information as possible so that the information doesn't become quickly redundant with changes. I hope that it helps the community.

Please have a quick look and check that it is alright.

It is a good start,

omega8cc's picture

It is a good start, thanks!

We will link the docs in the group header when there will be more articles posted.

Please see below

luiginica's picture

Please see below

luiginica's picture

Also I can sugest to have in the same place installation hints for different servers?
Like Ubuntu have for different types of notebooks here?.
Why?
Because often times our problems are not BOA related but server related (Xen, Dedi, OpenVZ) or they are caused by the hosting configs.
That way, you will not be bugged anymore with bugs that are not Barracuda/Octopus related.

So to have a KISS and a DRY, I sugest that we can maintain some wiki pages related to the environments. Because sooner or later we fix them right?
That way, next time when a user have a problem with a Xen at Linode or a dedicated at MediaTemple he don't need to log a bug request - he/she can take a look at our wiki and maybe he/she will find the same type of setup environment already explained and fixed by another user.
Also, we will have a central source of information. Otherwise we must read here and there, we must look through the bugs etc.

Maybe is not a good approach but it's an idea.

@nlcluigi

omega8cc's picture

I agree, but we need your help!

The docs here will be maintained by community, not by me, but of course I will always review them to make sure the information posted is correct. But it is you - the community who can make that happen! :)

BOA

Group organizers

Group notifications

This group offers an RSS feed. Or subscribe to these personalized, sitewide feeds:

Hot content this week