Skip to content

Commit

Permalink
Merge pull request #60 from bcc-code/building
Browse files Browse the repository at this point in the history
Add building instructions
  • Loading branch information
u12206050 authored Sep 23, 2024
2 parents 0e67886 + d6c9ad0 commit 4d52c69
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
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
```

0 comments on commit 4d52c69

Please sign in to comment.