- Notifications
You must be signed in to change notification settings - Fork1k
docs: add documentation about the offline docs#8603
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Let's also be sure to include theCODER_DOCS_URL docs here. Maybe let's hold off on merging until that is in? Otherwise, LGTM!
@bpmct it is merged already. I also updated the docs to include the env variable. |
| 2. Download the documentation files from the "Assets" section. It is named as`coder_docs_<version>.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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| 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. | |
| 5. Set the[CODER_DOCS_URL](../cli/server#--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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I will make a hotfix for this
No description provided.