Add building instructions

[OmniTroid]

Probably not entirely idiomatic or correct, but it should give some pointers as to how to work on this locally.

[Ghostbird]

Have we considered git submodules?

On Mon, 13 Feb 2023, 14:29 Laurens Groeneveld, @.***> wrote:

@.**** commented on this pull request.

In README.md https://github.com/bcc-code/bcc-code.github.io/pull/60#discussion_r1104470838 :

@@ -8,3 +8,25 @@ 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/ADLfolder will be created. + +# Building + +The site uses vuepress to build the pages. To build them locally, install vuepress: +``` +npm install -D @.***

Maybe suggest installing vuepress globally? Not sure if it would work but currently there is no package.json in the repository so then you have to take a lot of care to not accidentally commit it.

In README.md https://github.com/bcc-code/bcc-code.github.io/pull/60#discussion_r1104471878 :

+ +The site uses vuepress to build the pages. To build them locally, install vuepress: + +npm install -D ***@***.*** + + +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:

I suggest to also add a note that this is a rudimentary version of the website and will not be using the real theme, and stuff like the automatic sidebar will not work.

— Reply to this email directly, view it on GitHub https://github.com/bcc-code/bcc-code.github.io/pull/60#pullrequestreview-1295645539, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJFPZJ3HGI3UQNYMGOEAB3WXIZKXANCNFSM6AAAAAAUZJDLEY . You are receiving this because you are subscribed to this thread.Message ID: @.***>

[laurensgroeneveld]

Linking #57 for ease of access.

[laurensgroeneveld]

Have we considered git submodules?

I'm not really sure in what sense they would be helpful here. In any case, I think further discussion on the current setup is warranted. I created an issue in the documentation-base repository for that: https://github.com/bcc-code/bcc-documentation-base/issues/2

[u12206050]

@OmniTroid Can you make the required changes before we approve and merge this PR?