Docula: Persistent Links and Styles!
In our last update, we simplified the modules down to two (docula-ui, and docula-core) and also added In-Memory data stores as the default. Now with this latest update, we made it so that you can do persistent linking and customize the interface it very easily.
There are many times a document can move around in a GitHub repository, but you want to keep to an URL that works. Check out how to do it here!
The first step is to see how we did this. Since we use GitHub for our knowledge base repository, it made sense to extend the configuration for skinning there. Here is what the Fons repository looks like with the
navigation.html file in the root.
Github edit links in docs, full text searching and a easier configuration.
Thanks so much for the great response and feedback on Docula! Here are some more fixes and also some enhancements. Now you can add some code to easily let people click on the article and edit it via a pull request in Github.
The fixes are now in place for full text searching so that it will auto index as new documents come available. Just make sure to set it up with the following configuration on AWS or any Elastic Search provider.
No trick, just a treat! One of the big things that I love is the idea of making documentation (when needed) more of a community effort. In the past I have been in companies that seem to always rely on “customer support” or even specialized “tech writers” to do the documentation.
In my last role we really worked to remove that barrier and allow anybody to contribute but found the tools in place for documentation to be painful. It was usually a very stringent system that required some training or expertise to run. It came with a bunch of approval processes that nobody could remember or follow. Most of all it didn’t allow somebody to just quickly edit and go live.
Module Simplification and Customization in Docula!
Let the Simplification Begin! We have moved from three modules to now only two. docula-core: The core module with all the logic. (what makes docula tick & tock!).docula-ui: the web interface that you can customize using React and Express. The reason for this is to a) simplify the current development of this project (one less module to maintain), and b) there has been only two use cases:
Now you can easily create and include your customized header by just adding to the config the string of the HTML page you would like to use.
Redis is the core caching that is used in Docula but is also a pain when there is no Redis available or doing local development. Now, all caching will be in memory by default!
Page Titles, Path Remix, API Hotness, and Your Own Logo. Oh My!
Big updates to Docula over the last couple weeks and it is about time we got it all written down for everybody. Lets get started…
We have added a side navigation and also better design to the rendering engine that takes a standard OpenAPI spec document and makes it into something beautiful. Go see for yourself:
Since Docula is based on Github repositories we decided that it would be better to remove the idea of using index.md to what is used in Github. Now just use the default readme.md file at the root of your documentation repo and we pull it in as your default view for Docula.