Re-usable, flexible documentation "platform" for projects

[Cheetham, Anastasia]

On Oct 7, 2015, at 8:35 AM, Jonathan Hung <jhung at ocadu.ca<mailto:jhung at ocadu.ca>> wrote:

I think this documentation platform (docs-core, and docs-template) would be useful for Fluid Project as documentation and communication is a large part of the project. By contributing this tool to Fluid, other projects would then be able to implement new documentation sites easily.

I have used this system for the upcoming First Discovery Tool documentation (pull request: https://github.com/GPII/docs-first-discovery/pull/1 test site: http://acheetham.github.io/docs-first-discovery/).

It was delightful to work with: I was able to focus on the content and not spend time worrying about creating all the infrastructure, adding UIO, etc. I was able to easily extend the CSS to give the site a look-n-feel consistent with the FD tool interface and make other small tweaks. It’s easy to deploy to my local gh-pages for testing and review. All around, very very helpful. It will make putting up other docs – like VideoPlayer, for example – much quicker than without it.

+2

There are existing issues and feature requests which I have documented in the Fluid Project bug tracker<https://issues.fluidproject.org/issues/?jql=project%20%3D%20FLUID%20AND%20status%20%3D%20Open%20AND%20component%20%3D%20%22Tech.%20Documentation%22>. I hope these issues and features will be addressed over time.

I wonder if we might want to create a new JIRA component for these repositories, to allow us to distinguish between issues related to content and issues related to the infrastructure in these repositories...

--
Anastasia Cheetham – acheetham at ocadu.ca<mailto:acheetham at ocadu.ca>
Inclusive Design Research Centre
Inclusive Design Institute
OCAD University

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.idrc.ocad.ca/pipermail/fluid-work/attachments/20151026/558523c9/attachment.html>