From 05183aebb7c1fe271599005431a8788a8be5eec8 Mon Sep 17 00:00:00 2001 From: BrunoQuaresma Date: Wed, 19 Jul 2023 17:38:35 +0000 Subject: [PATCH 1/3] docs: add documentation about the offline docs --- docs/install/offline.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/install/offline.md b/docs/install/offline.md index f7573b5c999b2..fd0ae41d55471 100644 --- a/docs/install/offline.md +++ b/docs/install/offline.md @@ -185,3 +185,12 @@ coder: value: "" # ... ``` + +## Offline docs + +Coder also provides offline documentation in case you want to host it on your own server. The docs are exported as static files that you can host on any web server, as demonstrated in the example below: + +- Go to the release page. In this case, we want to use the [latest version](https://github.com/coder/coder/releases/latest). +- In the "Assets" section, you will find the file `coder_docs_.tgz`. Download it. +- Extract the file and move it to your server folder. +- If you are using NodeJS, you can execute the following command: `cd docs && npx http-server .` From a03549f79295cb3dd11946421aa62fc7c233bb95 Mon Sep 17 00:00:00 2001 From: BrunoQuaresma Date: Wed, 19 Jul 2023 18:27:13 +0000 Subject: [PATCH 2/3] Mention CODER_DOCS_URL --- docs/install/offline.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/install/offline.md b/docs/install/offline.md index fd0ae41d55471..625e463fcc311 100644 --- a/docs/install/offline.md +++ b/docs/install/offline.md @@ -190,7 +190,11 @@ coder: Coder also provides offline documentation in case you want to host it on your own server. The docs are exported as static files that you can host on any web server, as demonstrated in the example below: -- Go to the release page. In this case, we want to use the [latest version](https://github.com/coder/coder/releases/latest). -- In the "Assets" section, you will find the file `coder_docs_.tgz`. Download it. -- Extract the file and move it to your server folder. -- If you are using NodeJS, you can execute the following command: `cd docs && npx http-server .` +1. Go to the release page. In this case, we want to use the [latest version](https://github.com/coder/coder/releases/latest). +2. Download the documentation files from the "Assets" section. It is named as `coder_docs_.tgz`. +3. Extract the file and move its contents to your server folder. +4. If you are using NodeJS, you can execute the following command: `cd docs && npx http-server .` +5. Set the `CODER_DOCS_URL` environment variable to use the URL of your hosted docs. This way, the Coder UI will reference the documentation from your specified URL. + + +With these steps, you'll have the Coder documentation hosted on your server and accessible for your team to use. From f1506c401eeb0079e4a8fc086f90f0c505085658 Mon Sep 17 00:00:00 2001 From: BrunoQuaresma Date: Wed, 19 Jul 2023 18:29:35 +0000 Subject: [PATCH 3/3] Fix fmt --- docs/install/offline.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/install/offline.md b/docs/install/offline.md index 625e463fcc311..3862680ada579 100644 --- a/docs/install/offline.md +++ b/docs/install/offline.md @@ -196,5 +196,4 @@ Coder also provides offline documentation in case you want to host it on your ow 4. If you are using NodeJS, you can execute the following command: `cd docs && npx http-server .` 5. Set the `CODER_DOCS_URL` environment variable to use the URL of your hosted docs. This way, the Coder UI will reference the documentation from your specified URL. - With these steps, you'll have the Coder documentation hosted on your server and accessible for your team to use.