5 minutes to read
Installing docToolchain
Getting the Wrapper
The way docToolchain is installed has changed since the v2.x release. It now uses a simple wrapper script which takes care of everything.
This wrapper helps by:
-
Ensuring that everyone using your repository uses the same docToolchain version.
-
Keeping all docToolchain technology out of your repository.
-
Wrapping your commands and directing them to your local installation.
-
Checking your docToolchain installation (if not installed, the wrapper will do it for you via direct download or Docker).
This guide explains how to set up docToolchain in the following environments:
-
A Linux/WSL2 with bash
-
Windows with PowerShell
-
Windows with cmd.exe
Please select the appropriate setup and follow these instructions to install docToolchain step by step.
cd <your project>
wget doctoolchain.github.io/dtcw
chmod +x dtcw
if you don’t have wget
installed, you can also use curl
:
cd <your project>
curl -Lo dtcw doctoolchain.github.io/dtcw
chmod +x dtcw
cd <your project>
Invoke-WebRequest doctoolchain.github.io/dtcw.ps1 -Outfile dtcw.ps1
cd <your project>
curl -Lo dtcw.bat doctoolchain.github.io/dtcw.bat
dtcw.bat wraps the dtcw.ps1 script and executes it in powershell. This might be easier to use if you haven’t yet configured your powershell as a developer.
|
In order to support development for your project on both, Linux and Windows, it makes sense to download all three scripts to your project. |
if you use cmd.exe, follow the PowerShell instructions but replace .ps1 with .bat .
|
dtcw uses bash as shell and thus tries to find java from within bash. Chances are that when you use dtcw from another shell like zsh, you shell knows about the right java version but your bash doesn’t. In that case, please switch to bash and make sure that the right java version is known. Afterwards, you can switch back to your shell.
|
Running your First Command
To get started with docToolchain, run tasks
as the first command:
./dtcw tasks --group=doctoolchain
./dtcw.ps1 tasks --group=doctoolchain
if using cmd.exe replace .ps1 with .bat for all subsequent commands.
|
This command shows all docToolchain tasks and verifies that docToolchain is installed by doing the following:
-
Checking for a configuration file (and create one if none exist). Prefers a local installation.
-
Making use of Docker (if available) where there is no local installation.
If this is your first time installing docToolchain, the images download might take a while. |
-
if docker is not available, it will download and install docToolchain to your home folder
-
it will then run a gradle build through the gradle wrapper. If this is your first time, it will download and install gradle.
-
the gradle build will also fetch some dependencies. This will also take a while if run for the first time..
-
You’ll notice the installation is an incremental process and will take a while because of all the additional dependencies needed. After the first few commands, you’ll have all the required dependencies installed and things will run faster.
Existing Documents
If your project already has documents in AsciiDoc format, you’ll need to tell docToolchain where to find them.
To do so, take a look at the created docToolchainConfig.groovy
and update it.
arc42 from Scratch
If you don’t have existing documents yet, or if you need a fresh start, you can get the arc42 template in AsciiDoc format.
Run the command below to tell docToolchain to download the template of your choice:
./dtcw downloadTemplate
./dtcw.ps1 downloadTemplate
Building and Creating Templates.
By now, the docToolchain wrapper dtcw
should be in your project folder along with the arc42 template.
Now Let’s render it to HTML and PDF. To do so, run the commands below:
./dtcw generateHTML
./dtcw generatePDF
./dtcw.ps1 generateHTML
./dtcw.ps1 generatePDF
As a result, you will see the progress of your build together with some warnings which you can just ignore for the moment.
The first build generated some files within the build
:
build
|-- html5
| |-- arc42
| | `-- arc42.html
| `-- images
| |-- 05_building_blocks-EN.png
| |-- 08-Crosscutting-Concepts-Structure-EN.png
| `-- arc42-logo.png
`-- pdf
|-- arc42
| `-- arc42.pdf
`-- images
|-- 05_building_blocks-EN.png
|-- 08-Crosscutting-Concepts-Structure-EN.png
`-- arc42-logo.png
Congratulations! If you see the same folder structure, you’ve just rendered the standard arc42 template as HTML and PDF!
Please raise an issue on github if you didn’t get the right output.
Blog-Posts: Behind the great Firewall, Enterprise AsciiDoctor |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.