VividCortex's Open-Source Documentation

Posted by Alex Slotnick on Apr 15, 2016 3:54:00 PM

We were inspired by this recent post on CircleCI's blog, highlighting the many virtues of well-written and accessible documentation. Just as significantly, they point out the deeper value of making that documentation open-source. Documentation is where an engineering team can really elucidate its ideas and the execution that makes those ideas function; as CircleCI explains, it can be an invaluable resource for newcomers and veteran users alike. That sort of community inclusion is something we strongly agree with at VividCortex.

github-mark.png

With that in mind, we'd like to remind our customers, users, and readers that VividCortex's documentation is open-source, and we have a robust repository on Github, where you can view and actively comment on that documentation. You can find the repository here. Our docs and knowledgebase are continuously growing and improving, and community engagement is one of the best resources we have for ensuring those resources are as valuable and effective as possible.

Contributing 

As the repository explains, we appreciate any type of contribution that helps us improve. To contribute, you must first follow some simple steps. We use HUGO to build the static website and Grunt to compile the assets, build for production and publish tasks. Our FAQ on Github outlines exactly how you can perform those installations and how to use Grunt, plus understand the workflow. Of course, if you don't want to contribute changes directly, you can file an issue in the documentation itself.

As always, thank you for reading, contributing, and using VividCortex!

 

Recent Posts

Posts by Topic

see all