mirror of https://gitee.com/bigwinds/arangodb
Documentation/fix cookbook index (#3300)
* fix links and formatting in the index * add check for Headlines broken in the github render ergine * fix headlines
This commit is contained in:
parent
a1f217b323
commit
d3d524c49c
|
@ -12,7 +12,7 @@ and specify all choices available in the UI via commandline Arguments.
|
|||
|
||||
The options are as all other NSIS options specified in the form of `/OPTIONNAME=value`.
|
||||
|
||||
#Supported options
|
||||
## Supported options
|
||||
|
||||
*For Installation*:
|
||||
|
||||
|
@ -35,6 +35,6 @@ The options are as all other NSIS options specified in the form of `/OPTIONNAME=
|
|||
*For Uninstallation*:
|
||||
- PURGE_DB - [0/1] if set to 1 the database files ArangoDB created during its lifetime will be removed too.
|
||||
|
||||
#Generic Options derived from NSIS
|
||||
## Generic Options derived from NSIS
|
||||
|
||||
- S - silent - don't open the UI during installation
|
||||
|
|
|
@ -1,11 +1,12 @@
|
|||
# Cookbook
|
||||
|
||||
This cookbook is filled with recipes to help you understand the [multi-model database ArangoDB][1] better
|
||||
This cookbook is filled with recipes to help you understand the [multi-model database ArangoDB](https://www.arangodb.com/) better
|
||||
and to help you with specific problems.
|
||||
|
||||
You can participate and [write your own recipes][2]. You only need to write a recipe in markdown and make a [pull request to our repository][2].
|
||||
You can participate and [write your own recipes][2].
|
||||
You only need to write a recipe in markdown and make a [pull request to our repository][2].
|
||||
|
||||
##Recipes
|
||||
## Recipes
|
||||
|
||||
There will be some simple recipes to bring you closer to ArangoDB and show you the amount of possibilities
|
||||
of our Database.
|
||||
|
@ -21,5 +22,4 @@ Every recipe has tags to for a better overview:
|
|||
|
||||
*#api*, *#aql*, *#arangosh*, *#collection*, *#database*, *#debian*, *#docker*, *#document*, *#driver*, *#foxx*, *#giantswarm*, *#graph*, *#howto*, *#java*, *#javascript*, *#join*, *#nodejs*, *#windows*
|
||||
|
||||
[1]: https://www.arangodb.com/
|
||||
[2]: https://github.com/arangodb/arangodb/tree/devel/Documentation/Books/Cookbook
|
||||
|
|
|
@ -113,6 +113,19 @@ function ppbook-precheck-bad-code-sections()
|
|||
fi
|
||||
}
|
||||
|
||||
function ppbook-precheck-bad-headings()
|
||||
{
|
||||
NAME="$1"
|
||||
echo "${STD_COLOR}##### checking for headers that won't proper display on github in ${NAME}${RESET}"
|
||||
if grep -qRI '^##*[a-zA-Z]' "${NAME}"; then
|
||||
echo "${ERR_COLOR}"
|
||||
echo "Headlines broken on github found: "
|
||||
grep -RI '^##*[a-zA-Z]' "${NAME}"
|
||||
echo "${RESET}"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
function ppbook-check-html-link()
|
||||
{
|
||||
NAME="$1"
|
||||
|
@ -338,6 +351,7 @@ function build-book()
|
|||
export NAME="$1"
|
||||
echo "${STD_COLOR}##### Generating book ${NAME}${RESET}"
|
||||
ppbook-precheck-bad-code-sections "${NAME}"
|
||||
ppbook-precheck-bad-headings "${NAME}"
|
||||
|
||||
if test ! -d "ppbooks/${NAME}"; then
|
||||
mkdir -p "ppbooks/${NAME}"
|
||||
|
|
Loading…
Reference in New Issue