README.md 2.04 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
# Bonita Continuous Delivery documentation resources

This repository contains Bonita Continuous Delivery documentation site content.
It uses [Markdown](https://help.github.com/categories/writing-on-github/) to create documentation content.


## View rendered content on GitHub

Using the [Github Markdown Format](https://help.github.com/categories/writing-on-github/) allows to check the documentation directly on the GitHub repository website.

11 12 13
Hence a simple way to view documentation content is to browse the `md` folder on [GitHub website](md).

This [Table of contents](md/taxonomy.md) is also provided to ease your navigation.
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

## Build project

The project contains several tasks to generate the documentation content.

### HTML

Use `npm run build` to have the HTML files generated to the `build/html` directory.

This command requires 2 arguments:
- `version` - Documentation version string. Example: `1.0`. If no version argument is provided, then version is read from the `scripts/variables.json` file.
- `application` - URL prefix when serving documentation images. Image URLs will be like:
```html
<img src="${application}/images/${version}/<image_filename>"/>
```

**Example**: With version=`1.0` and application=`bcd`, generated HTML will contain `img` tags like:
```html
<img src="bcd/images/1.0/bcd_overview.png"/>
```

Providing arguments to the HTML build command is done with one of the following syntaxes:
```bash
npm run build -- [application] [version]
npm run build -- -a [application] -v [version]
npm run build -- -a [application]
```

Examples:
```bash
npm run build -- bcd 1.0
npm run build -- -a bcd -v 1.0
npm run build -- -a bcd
```

### Taxonomy

Once the HTML content has been generated, the `taxonomy.json` file can be generated from the `build/html/taxonomy.html` file.

Use the `npm run taxonomy` command to do so.

## Contribute

To help you contributing to Bonita Continuous Delivery documentation, we provide a set of [contribution guidelines](https://github.com/bonitasoft/bonita-doc/blob/7.3/CONTRIBUTING.md).

Thanks for taking time to contribute!