From e04fc9dea5677e31fc37fc83ead4d0b5462f55a6 Mon Sep 17 00:00:00 2001 From: David Skoland Date: Sun, 12 Feb 2023 13:39:57 +0100 Subject: [PATCH 1/4] Add building instructions --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index faab72d..4ddbd55 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,23 @@ Here files from different docs folders are collected and displayed to developers 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, install vuepress: +```npm install -D vuepress@next``` + +Then add the build commands to package.json + +``` + "scripts": { + "docs:dev": "vuepress dev docs", + "docs:build": "vuepress build docs" + } +``` + +Then you can build the docs locally with this command: + +``` +npm run docs:dev +``` From 2ffc8e820c5f8d13823c8df5d99ddfd93bf0f8a5 Mon Sep 17 00:00:00 2001 From: David Skoland Date: Sun, 12 Feb 2023 13:42:15 +0100 Subject: [PATCH 2/4] Make backtick code consistent --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ddbd55..dbf0f2f 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,9 @@ 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, install vuepress: -```npm install -D vuepress@next``` +``` +npm install -D vuepress@next +``` Then add the build commands to package.json From 5d5e7f678e5f553681a8dfe5ac6806067418ce4f Mon Sep 17 00:00:00 2001 From: David Skoland Date: Tue, 17 Oct 2023 21:21:16 +0200 Subject: [PATCH 3/4] Formatting --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index eb2bca2..177bb45 100644 --- a/README.md +++ b/README.md @@ -1,27 +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) -# 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. +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 +## Building The site uses vuepress to build the pages. To build them locally, install vuepress: -``` + +```(bash) npm install -D vuepress@next ``` Then add the build commands to package.json -``` +```(bash) "scripts": { "docs:dev": "vuepress dev docs", "docs:build": "vuepress build docs" @@ -30,6 +31,6 @@ Then add the build commands to package.json Then you can build the docs locally with this command: -``` +```(bash) npm run docs:dev ``` From d6c9ad0c4b744b12c02b6e6d5284c401df71f7cc Mon Sep 17 00:00:00 2001 From: David Skoland Date: Tue, 17 Oct 2023 21:25:05 +0200 Subject: [PATCH 4/4] Add more info to readme, remove package.json section --- README.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 177bb45..217d122 100644 --- a/README.md +++ b/README.md @@ -14,23 +14,15 @@ 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, install vuepress: +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 -D vuepress@next +npm install -g vuepress@next ``` -Then add the build commands to package.json +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) - "scripts": { - "docs:dev": "vuepress dev docs", - "docs:build": "vuepress build docs" - } -``` - -Then you can build the docs locally with this command: - -```(bash) -npm run docs:dev +vuepress dev docs ```