Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Commit

Permalink
update dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
brianinnes committed Oct 17, 2023
1 parent cf5cd2c commit 038c1ea
Show file tree
Hide file tree
Showing 8 changed files with 1,074 additions and 855 deletions.
2 changes: 1 addition & 1 deletion .github/actions/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM squidfunk/mkdocs-material:9.1.6
FROM squidfunk/mkdocs-material:9.4.6

RUN apk add --no-cache --update nodejs npm

Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

# Ignore .DS_store file
.DS_Store
.cache

*.code-workspace
/public
Expand Down
2 changes: 1 addition & 1 deletion build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

[ ! -d "node_modules" ] && npm ci

./node_modules/cspell/bin.js "docs/**/*.md"
./node_modules/.bin/cspell "docs/**/*.md"
mkdocs build
linkchecker -f linkcheckerrc public || true
2 changes: 1 addition & 1 deletion dev/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM squidfunk/mkdocs-material:9.1.6
FROM squidfunk/mkdocs-material:9.4.6

RUN apk add --no-cache --update nodejs npm

Expand Down
23 changes: 20 additions & 3 deletions docs/wg_docs/doc-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,32 @@ To work on documentation and be able to view the rendered web site you need to c
- [Node.js](https://nodejs.org/en/){: target=_blank}
- [Python 3](https://www.python.org){: target=_blank}

You can create the environment by :
You can create the environment by :

- running the tooling within a container runtime, so you don't need to do any local installs
- if you have an Eclipse Che installation on an OKD cluster then you can make the changes using only a browser, with all the tooling running inside Che on the OKD cluster.
- installing the components on your local system

=== "Tooling within a container"

You can use a container to run MkDocs so no local installation is required, however you do need to have [Docker Desktop](https://www.docker.com/products/docker-desktop){: target=_blank} installed if using Mac OS or Windows. If running on Linux you can use **Docker** or **Podman**.
You can use a container to run MkDocs so no local installation is required. You need a container runtime on your system.

The recommended options are:

- If running on Windows or MacOS you can run [Docker Desktop](https://www.docker.com/products/docker-desktop){: target=_blank}
- if running on Windows pr MacOS you can run [Podman](https://podman.io/docs/installation){: target=_blank} or [Podman Desktop](https://podman-desktop.io){: target=_blank}
- if running on Linux you can run [Podman](https://podman.io/docs/installation){: target=_blank}

On Windows and MacOS you need to ensure the Docker or Podman system is running

!!!Info
On MacOS you need to ensure the directory you are working in is available within the podman virtual machine. You can specify additional directories to mount when issuing the `podman machine init` command. An example command to initialise the podman machine on MacOS could be:

```shell
podman machine init --cpus 6 --disk-size 150 -m 8096 --now -v /Users:/Users -v /private:/private -v /var/folders:/var/folders
```

This specifies the CPU, disk and memory resource to give the podman amchine and also the directories to mount into the virtual machine. This ensures that all user home directories are available within the podman machine.

*If you have a node.js environment installed that includes the npm command then you can make use of the run scripts provided in the project to run the docker or podman commands*

Expand Down Expand Up @@ -266,4 +283,4 @@ You can create the environment by :
That's it. 662 links in 695 URLs checked. 0 warnings found. 0 errors found
```

Any issues reported should be fixed before submitting a pull request to add your changes to the okd.io site.
Any issues reported should be fixed before submitting a pull request to add your changes to the okd.io site.
1,889 changes: 1,045 additions & 844 deletions package-lock.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@
"author": "Brian Innes",
"license": "ISC",
"devDependencies": {
"cspell": "^6.31.1"
"cspell": "^7.3.8"
}
}
8 changes: 4 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Do not use with Docker builds, only for local dev with mkdocs CLI
mkdocs==1.4.2
mkdocs-material==9.1.6
mkdocs-minify-plugin==0.6.4
git+https://github.com/linkchecker/linkchecker@v10.1.0#egg=linkchecker
mkdocs==1.5.3
mkdocs-material==9.4.6
mkdocs-minify-plugin==0.7.1
git+https://github.com/linkchecker/linkchecker@v10.3.0#egg=linkchecker

0 comments on commit 038c1ea

Please sign in to comment.