[csw-devel] SF.net SVN: gar:[20876] csw/mgar/pkg/opencsw-manual/trunk/files/ for-maintainers/about-documentation.rst
wahwah at users.sourceforge.net
wahwah at users.sourceforge.net
Sat Apr 27 10:19:52 CEST 2013
Revision: 20876
http://gar.svn.sourceforge.net/gar/?rev=20876&view=rev
Author: wahwah
Date: 2013-04-27 08:19:45 +0000 (Sat, 27 Apr 2013)
Log Message:
-----------
opencsw-manual/trunk: syntax fixes and small changes
Modified Paths:
--------------
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/about-documentation.rst
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/about-documentation.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/about-documentation.rst 2013-04-27 07:45:35 UTC (rev 20875)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/about-documentation.rst 2013-04-27 08:19:45 UTC (rev 20876)
@@ -10,21 +10,30 @@
There are 5 places for documentation at OpenCSW:
* `OpenCSW wiki`_
+
* Optimized for frequent changes.
* Used for ongoing issues, such as projects in progress.
* Powered by Wikidot, has own user name space, separate sign-up and login.
+
* `OpenCSW manual`_ (this document is part of it)
+
* Less frequently changing, but more reviewed and polished documentation.
* Part of the source code repository.
+
* `GAR documentation`_
+
* Used for GAR / build system specific documentation.
* Lives in the GAR project SourceForge area.
* Uses SourceForge credentials.
+
* `Main OpenCSW website`_
+
* Used for general project information
* Lives in the project Wordpress site
* Own user name space, separate sign-up and login
+
* `Community Q&A`_
+
* Used for questions from users.
* Own user name space, separate sign-up and login, but accepts
Google accounts, Facebook and Twitter.
@@ -35,9 +44,9 @@
---------------------
Many documentation locations have own user name spaces, and require separate
-application and approval. If you're a maintainer and you don't have permissions
-to edit the wiki, set up an account on wikidot.com and write to maintainers@ or
-ask on the IRC channel to get it added to the project.
+account applications and approvals. If you're a maintainer and you don't have
+permissions to edit the wiki, set up an account on wikidot.com and write to
+maintainers@ or ask on the IRC channel to get your user added to the project.
If you're a maintainer and you notice something wrong or missing in any of the
above places, don't leave it broken! If you're not sure what's supposed to be
@@ -49,7 +58,7 @@
---------------------------------------------------
If you notice a piece of documentation that you know is incorrect or obsolete,
-DELETE IT. Yes, really! Even if you don't know what's supposed to be there, so
+DELETE IT. Yes, really! Even if you don't know what's supposed to be there, and
deleting is the only thing you can do.
Don't be concerned about losing content ‒ wikis and wordpress are versioned,
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the devel
mailing list