A documentation toolchain that helps technical writing teams create, manage, collaborate on, remix, and publish documentation sites sourced from a variety of versioned content repositories.
docToolchain is composed of two parts:
-
doctoolchain which is the toolchain used to create your documentation
-
the docToolchain shell wrapper script installed in your project which calls the toolchain
The use of this setup has the following advantages:
-
It’s easy to build your documentation within your project folder.
-
Ensures that everyone in the project uses the same docToolchain version.
-
Keeps all docToolchain technology out of your project repository.
-
Facilitates the installation of the docToolchain if not installed.
-
Makes it easier to upgrade to never versions of docToolchain.
There are times when you’ll want to publish your docs to Confluence, such as when you work in a team where not everyone wants to work with Git. docToolchain lets you publish your Git-based docs to Confluence alongside manually edited Confluence pages.
The open internet is a great place to code, but sometimes you are sitting behind a great firewall in a corporate environment. Your are not allowed to just pull the hottest stuff from the internet, but have to go through an internal binary artifact repository like nexus or artifactory.
-- Ralf D. Müller, Groovy enthusiast, arc42 contributor, docToolchain maintainer
Create awesome docs the easy way!
docToolchain is a collection of scripts that makes it easy to create and maintain powerful technical documentation. Built on best-of-breed open source technologies, we deliver the best docs toolchain so you don’t have to.