Skip to content
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

Migrate to using Docsy as an npm module #557

Open
SayakMukhopadhyay opened this issue Dec 19, 2024 · 8 comments
Open

Migrate to using Docsy as an npm module #557

SayakMukhopadhyay opened this issue Dec 19, 2024 · 8 comments

Comments

@SayakMukhopadhyay
Copy link
Contributor

We would like to move from using Docsy as a git submodule to an NPM dependency. This is the proposed approach for the docs website (kubernetes/website#48812) and we would like to do it here too, ideally after #531 is merged.

@jberkus
Copy link
Contributor

jberkus commented Dec 19, 2024

Sounds good, let Contribex know when you want to get started.

@SayakMukhopadhyay
Copy link
Contributor Author

I will work on it but I would like #531 to be merged first as I know that the PR works right now. Doing this before #531 would mean additional rework.

@sftim
Copy link
Contributor

sftim commented Dec 22, 2024

I think we should do this before #531; I just saw that the change doesn't actually preview OK @SayakMukhopadhyay. Adopting the approach planned for k/website should fix this issue and make upgrades easier.

@SayakMukhopadhyay
Copy link
Contributor Author

@sftim I saw your comment on the kubernetes/website#48726 PR. Are you considering using Hugo modules for managing the docsy themes?

@SayakMukhopadhyay
Copy link
Contributor Author

I think we should do this before #531; I just saw that the change doesn't actually preview OK @SayakMukhopadhyay. Adopting the approach planned for k/website should fix this issue and make upgrades easier.

The problem is that the current version of Docsy that is deployed didn't support themeing in either NPM or Go modules way. Git Submodules was the only option. So, this change cannot happen without migrating to at least 0.5.

@sftim
Copy link
Contributor

sftim commented Dec 22, 2024

Let's move to Docsy 0.5.1 (same approach as k/website). Then, continue onwards.

@SayakMukhopadhyay
Copy link
Contributor Author

In fact, the change from 0.5 to 0.6 is trivial. Its 0.7 which brings the new bootstrap stuff. So, I am ready to split #531 into 2 PRs. I can rebase #531 to keep until 0.6 and a new PR to 0.11

@sftim
Copy link
Contributor

sftim commented Dec 22, 2024

Let's move to Docsy 0.5.1 (same approach as k/website). Then, continue onwards.

Still my recommendation. 0.6 is fine; moving via 0.5.1 will make things overall easier for approvers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants