-
Notifications
You must be signed in to change notification settings - Fork 6k
docs(install): Fix link to helm readme #3869
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report
@@ Coverage Diff @@
## main #3869 +/- ##
=======================================
Coverage 63.40% 63.40%
=======================================
Files 36 36
Lines 1872 1872
Branches 379 379
=======================================
Hits 1187 1187
Misses 582 582
Partials 103 103 Continue to review full report at Codecov.
|
@@ -234,7 +234,7 @@ alternative](https://hub.docker.com/r/linuxserver/code-server). | |||
|
|||
## Helm | |||
|
|||
You can install code-server via [Helm](../ci/helm-chart/README.md). | |||
You can install code-server via [Helm](https://github.com/cdr/code-server/blob/main/ci/helm-chart/README.md). |
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.
Hmm, that's strange, why does this need to be an absolute link? The relative link does seem to work ok (see preview) but it links to https://coder.com/docs/code-server/v3.11.0/ci/helm-chart/README
(missing the .md extension)
I don't know if something else is going on here 🤔
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.
Hey @jawnsy - From what I can tell, content located in ci
is not rendered on coder.com.
Adding the .md
extension doesn't fix this, try this link:
https://coder.com/docs/code-server/v3.11.0/ci/helm-chart/README.md
I think it needs to be an absolute link unless we also intend on hosting ci/helm-chart/README.md
on coder.com/docs from what I see.
We seem to only host the docs/
directory (see docs/manifest.json):
https://github.com/cdr/code-server/blob/main/docs/manifest.json
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.
Yeah I think @BrunoQuaresma knows more about this but at least we can fix this issue for now, get people to the right docs and then improve later if needed!
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.
Yes, if we want to add it to the docs page, we have to move it to live inside of the docs folder.
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.
Sweet! made a followup issue: #3877
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.
Thanks for fixing this @vapurrmaid and thanks @jawnsy for asking good questions and helping review! 🙌
Fixes #3867