Documents - The Basics

The DATRO's document library is pioneering. All of our documents are stored in reStructuredText format (plain text, in English) within our public source-code monorepo. And we provide the tools and training for any member of the public to contribute improvements and earn a share of the royalties from our network for their contribution(s). Which you can learn how to do through our academy.

Contained within the monorepo is a simple compiler script the contributor can run. This will autonomously re-publish changes to the text, as html and pdf. It also autonomously provides links to the older document version (within the changelog of the newer publication). The contributor must manually archive the latest version before making their changes in accordance with our README.md & COLLABORATOR.md files. Further to this we've developed a custom web-app for the contributor to do all this from a single interface. Our document editor web-app is also a single php, so it can be dropped on to a local (or remote) web-server and used instantly, without any complex configuration. This web-app also comes as standard in our To-Go USB Disk Image to make the life of a developer or technical writer, even easier.

DATRO uses the universal standard of semantic versioning, but we've improved on it slightly. Each time a HotspotBnB document is revised, it's semantic version is increased e.g. 0.0.2 > 0.0.3 etc. Straightforward enough right? But these documents are all contained within our 'platform' (a fancy word for the 'gh-pages' branch of our source-code repository/ monorepo), where all of our static websites are kept e.g. /static/datro, /static/wave, /static/hbnb etc). Like with the websites, these documents have their own dedicated sub-directory (static/files). Similar to the documents, the DATRO 'platform' is also given a new semantic version number when it's re-released, except it has a uniquily identifiable semantic version extension (called RTW (Release to Web) e.g. 0.0.1-rtw-6). The software re-releases that the document(s) correspond to are also given their own unique semantic versioning extension. In the case of HotspotBnB's Net Installer for the Raspberry Pi we use RC (Release Candidate e.g. 0.0.6-rc.3). So while 'document 0.0.1' is the abbreviated semantic version, the full document version is in fact '0.0.1-rtw.8--0.0.3--0.0.6-rc.3', which tells us it's document revision version 0.0.1, taken from platform release 0.0.1-rtw.8, and it corresponds to HotstpoBnB software release 0.0.6-rc.3.

To be clear, the various softwares have their own separate branch(es) and semantic version extensions. For example, the To-Go USB Disk Image is x.x.x-rtm (Release to Market), While the HotspotBnB Automated Installer (for all models of Raspberry Pi) is released under the extension RC. Having different extensions quickly enables us to know the branch and solution which the complied deliverable is refering to.