Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: add offline docs #8527

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

Merged
merged 13 commits into from
Jul 19, 2023
Merged

feat: add offline docs #8527

merged 13 commits into from
Jul 19, 2023

Conversation

BrunoQuaresma
Copy link
Collaborator

@BrunoQuaresma BrunoQuaresma commented Jul 14, 2023

Related to #5466

Screen Shot 2023-07-14 at 15 30 36

@BrunoQuaresma BrunoQuaresma self-assigned this Jul 14, 2023
@bpmct
Copy link
Member

bpmct commented Jul 14, 2023

So this is going to be in a different artifact? #8110

@BrunoQuaresma
Copy link
Collaborator Author

@bpmct Yes, so the user can download the .tar file and host the docs where they want to.

@matifali
Copy link
Member

@BrunoQuaresma but we should make it linkable from the Coder dashboard.

@BrunoQuaresma
Copy link
Collaborator Author

You can follow the RFC discussion to see the reasons we decided to not do it rn but it can be added in the future if we see more users asking for the feature.

@bpmct
Copy link
Member

bpmct commented Jul 15, 2023

Ah, but I thought we are going to support setting a custom docs link URL for in-product docs links?

CODER_DOCS_URL=https://coder-docs.example.com/

Screenshot 2023-07-15 at 2 56 10 PM

Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, you may wish to keep the dependencies updated by adding an entry for offlinedocs in .github/dependabot.yaml

@matifali
Copy link
Member

I like the light theme.

@BrunoQuaresma
Copy link
Collaborator Author

Ah, but I thought we are going to support setting a custom docs link URL for in-product docs links?

CODER_DOCS_URL=https://coder-docs.example.com/

Screenshot 2023-07-15 at 2 56 10 PM

We definitely can do it. It is very easy, thanks for bringing this.

Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest adding an entry for offline docs to dependabot.yaml.
Other than that ci looks good.

@BrunoQuaresma
Copy link
Collaborator Author

I think for now it is ok to not have a dependabot for the offlinedocs but I will keep that in mind for sure.

@deansheather
Copy link
Member

I changed it to .tgz (aka. .tar.gz) to match our Helm artifact. It'll show up in the release as coder_docs_$(VERSION).tgz

@BrunoQuaresma
Copy link
Collaborator Author

/deploy-pr

@BrunoQuaresma BrunoQuaresma merged commit acc12d3 into main Jul 19, 2023
@BrunoQuaresma BrunoQuaresma deleted the bq/offline-docs branch July 19, 2023 16:57
@github-actions github-actions bot locked and limited conversation to collaborators Jul 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants