From 5a0d0b2fe16650c45b910d5d20029cd60f369dd5 Mon Sep 17 00:00:00 2001 From: Jakub Matys Date: Thu, 9 Aug 2018 14:33:17 +0200 Subject: [PATCH] fixes --- CONTRIBUTING.md | 8 -------- docs/build.md | 10 ++++++---- docs/config.md | 8 ++++++++ 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36c67fd8..1e3973d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,14 +67,6 @@ Execute script *contrib/scripts/generate-port-registry.go* that will update *doc Now you can try generate package definitions as described above in order to check outputs. -##### Go template evaluation note - -We use *text/template* package to generate package definitions and configuration files. Some options in coin definition -are also templates and are executed inside base template. Use `{{.path}}` syntax to refer values in coin definition, -where *.path* can be for example *.Blockbook.BlockChain.Parse*. Go uses CammelCase notation so references inside templates -as well. Note that dot at the beginning is mandatory. Go template syntax is fully documented -[here](https://godoc.org/text/template). - TODO: * script that checks unique port numbers diff --git a/docs/build.md b/docs/build.md index cd7b050b..55847a2b 100644 --- a/docs/build.md +++ b/docs/build.md @@ -93,15 +93,17 @@ command: `make build-images NO_CACHE=true`. ### On naming conventions and versioning +All configuration keys described below are in coin definition file in *configs/coins*. + **install and data directories** Both Blockbook and back-end have separated install and data directories. They use common preffix and are defined in *configs/environ.json* and all templates use them. -Back-end install directory is */opt/coins/nodes/<coin>*. -Back-end data directory is */opt/coins/data/<coin>/backend*. -Blockbook install directory is */opt/coins/blockbook/<coin>*. -Blockbook data directory is */opt/coins/data/<coin>/blockbook*. +* back-end install directory is */opt/coins/nodes/<coin>*. +* back-end data directory is */opt/coins/data/<coin>/backend*. +* Blockbook install directory is */opt/coins/blockbook/<coin>*. +* Blockbook data directory is */opt/coins/data/<coin>/blockbook*. *coin* used above is defined in *coin.alias* in coin definition file. diff --git a/docs/config.md b/docs/config.md index 2d0a9e67..bfeec71b 100644 --- a/docs/config.md +++ b/docs/config.md @@ -95,3 +95,11 @@ Good examples of coin configuration are * `package_maintainer` – Full name of package maintainer. * `package_maintainer_email` – E-mail of package maintainer. +### Go template evaluation note + +We use *text/template* package to generate package definitions and configuration files. Some options in coin definition +are also templates and are executed inside base template. Use `{{.path}}` syntax to refer values in coin definition, +where *.path* can be for example *.Blockbook.BlockChain.Parse*. Go uses CammelCase notation so references inside templates +as well. Note that dot at the beginning is mandatory. Go template syntax is fully documented +[here](https://godoc.org/text/template). +