Work has been completed - https://github.com/CouchCMS/Documentation
The pages are hosted - http://docs.couchcms.com/
Original post below:
Hi everybody,
Until now the Couch documentation has been hosted on the Couch server and managed with ... Couch, of course...
This has unfortunately meant that the system is closed to others - no direct community involvement. The documentation has also struggled somewhat to stay current with new releases. This applies to the zip download as well, which must be manually compiled after each edit.
With those issues in mind, I have been looking for some solutions and came up with the following -
Placing the documentation on GitHub opens up the system to others for collaboration. The latest files can then be downloaded (in zip format) or cloned with Git at any time.
The contents should be converted to Markdown to ensure maintainability. A static site generator is used to create HTML pages for offline (and online) browsing.
To synchronize this with what is displayed on the official site, we would use the GitHub Pages service on a subdomain (docs.couchcms.com) and permanently redirect old requests to the new location.
I have been busy implementing all of this and hope to have it completed shortly.
Thanks for listening.
The pages are hosted - http://docs.couchcms.com/
Original post below:
Hi everybody,
Until now the Couch documentation has been hosted on the Couch server and managed with ... Couch, of course...
This has unfortunately meant that the system is closed to others - no direct community involvement. The documentation has also struggled somewhat to stay current with new releases. This applies to the zip download as well, which must be manually compiled after each edit.
With those issues in mind, I have been looking for some solutions and came up with the following -
Placing the documentation on GitHub opens up the system to others for collaboration. The latest files can then be downloaded (in zip format) or cloned with Git at any time.
The contents should be converted to Markdown to ensure maintainability. A static site generator is used to create HTML pages for offline (and online) browsing.
To synchronize this with what is displayed on the official site, we would use the GitHub Pages service on a subdomain (docs.couchcms.com) and permanently redirect old requests to the new location.
I have been busy implementing all of this and hope to have it completed shortly.
Thanks for listening.
