-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #60 from bcc-code/building
Add building instructions
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,28 @@ | ||
# developer.bcc.no | ||
|
||
The source for [developer.bcc.no](https://developer.bcc.no), the central portal for developers within BCC. | ||
|
||
Here files from different docs folders are collected and displayed to developers who will or want to work with BCC-Code products | ||
|
||
Pages are built from the `docs` folder with the [common documentation setup](https://developer.bcc.no/bcc-documentation-base/deploying-site/). | ||
|
||
## ADL (with ADRs) | ||
|
||
To create a new ADR (Architecture Decision Log) please create a new issue with given template. This will include all required sections with a "adr" label. | ||
|
||
After the issue is close, a new `*.md` file in `/docs/ADL`folder will be created. | ||
|
||
## Building | ||
|
||
The site uses vuepress to build the pages. To build them locally, you need vuepress installed, which can be installed globally by: | ||
|
||
```(bash) | ||
npm install -g vuepress@next | ||
``` | ||
|
||
Then you can build a rudimentary version the docs locally with this command | ||
(note that this isn't the real theme and things like automatic sidebar won't work) | ||
|
||
```(bash) | ||
vuepress dev docs | ||
``` |