Skip to content

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 29, 2021
Merged

docs(install): Fix link to helm readme #3869

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Contributor

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 🤔

Copy link
Contributor Author

@greyscaled greyscaled Jul 29, 2021 •
edited
Loading

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

image

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

Copy link
Contributor

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!

Copy link
Contributor

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.

Copy link
Contributor

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


## Raspberry Pi

Expand Down