Skip to content

Commit 48c28c3

Browse files
committed
apply markdownlint and dockerlint suggestions
1 parent 434acea commit 48c28c3

File tree

3 files changed

+22
-11
lines changed

3 files changed

+22
-11
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ WORKDIR /opt/node_app
1111

1212
COPY package.json package-lock.json* ./
1313
RUN npm install --verbose --include=dev && npm cache clean --force
14-
ENV PATH /opt/node_app/node_modules/.bin:$PATH
14+
ENV PATH=/opt/node_app/node_modules/.bin:$PATH
1515

1616
HEALTHCHECK --interval=30s CMD node healthcheck.js
1717

Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
#!/usr/bin/make -f
22

3+
PWD=$(shell pwd)
34
DOCKERRUN=docker run \
45
--rm -it \
56
-p 5173:5173 \
67
--name=naemon-docs \
7-
-v `pwd`:/opt/node_app/app \
8+
-v $(PWD):/opt/node_app/app \
89
-v /opt/node_app/node_modules/ \
910
-v /opt/node_app/app/.vitepress/cache \
1011
-v /opt/node_app/app/.vitepress/dist \
11-
-v `pwd`/package.json:/opt/node_app/package.json \
12+
-v $(PWD)/package.json:/opt/node_app/package.json \
1213
naemon/docs:latest
1314

1415
docker-build:

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,21 @@ To do so, all old files got moved into the `legacy` folder using `git mv`. This
1616
To migrate a page from Jekyll to VitePress, you have to use the `git mv` command, to move the file from the `legacy` folder into the
1717
new VitePress project located in `src`.
1818

19-
```
19+
```sh
2020
git mv legacy/documentation/usersguide/config-incompat3to4.md src/documentation/usersguide/
2121
```
2222

2323
In the next step, edit the file, apply all the required changes and command your work.
2424

25-
2625
## Run development server
2726

2827
Please see the documentation of how to setup a local copy of the Naemon website.
2928

30-
[Run Naemon Website Locally ](./documentation/developer/website.md)
29+
[Run Naemon Website Locally](./documentation/developer/website.md)
3130

3231
### In a nutshell
33-
```
32+
33+
```sh
3434
git clone https://github.com/naemon/naemon.github.io.git
3535
cd naemon.github.io/
3636

@@ -39,18 +39,29 @@ npm run docs:dev
3939
```
4040

4141
### Using Docker
42+
4243
In case you do not want to install Nodejs to your system, you can also use Docker
4344

4445
First build the Docker image which will contain N Nodejs - thats all this documentation has no dependencies
45-
```
46+
47+
```sh
4648
docker build . -t naemon/docs
4749
```
4850

4951
Now run the Docker container and navigate to `http://127.0.0.1:5173` in your browser.
5052
The container watches for file changes and will automatically regenerate the website if needed.
5153

52-
```
53-
docker run --rm -it -v "$PWD":/site -p "5173:5173" naemon/docs:latest
54+
```sh
55+
docker run \
56+
--rm -it \
57+
-p 5173:5173 \
58+
--name=naemon-docs \
59+
-v $PWD:/opt/node_app/app \
60+
-v /opt/node_app/node_modules/ \
61+
-v /opt/node_app/app/.vitepress/cache \
62+
-v /opt/node_app/app/.vitepress/dist \
63+
-v $PWD/package.json:/opt/node_app/package.json \
64+
naemon/docs:latest
5465
```
5566

5667
### Important for the Migration
@@ -60,7 +71,6 @@ docker run --rm -it -v "$PWD":/site -p "5173:5173" naemon/docs:latest
6071
3. You can modify HTML anchors like so: `## What Is Naemon? {#whatis}`
6172
4. Add code blocks `like this` for code instead of quotes 'like so'.
6273

63-
6474
### Goals and Motivation
6575

6676
1. Get a dependency free documentation, (only Nodejs and VitePress) but no GitHub Pages, Jekyll and Ruby anymore.

0 commit comments

Comments
 (0)