holoviz
docs: Add versioning to documentation
https://hvplot-test.holoviz.org
TODO:
- [ ] correct s3 region?
- [x] redirect to /en/docs/latest/ for versioning (and will also redirect old pages)
- [x] https://hvplot-test.holoviz.org/en/docs/latest/ should not download a file
- [x] choose version switcher url
- [ ] Merge Github action and update link https://github.com/holoviz/hvplot/pull/1533#discussion_r2035682618
Nice to see some progress!
I'm very much interested in a doc collecting your process and all the decisions and settings you've made. A big part of this system is going to be in AWS as far as I can see, and I would like to know how complex it is, the easiest way for me being to review this doc, as poking around in AWS isn't going to be effective. I guess you're done with the exploration/looking around phase since you've started the implementation. I would like to know if you looked into relying on readthedocs? And if you did and decided not to use it, why?
I'm very much interested in a doc collecting your process and all the decisions and settings you've made
This was also what I had planned to do, but I'm not that familiar with AWS, so I wanted something that worked before I tried to write it up.
I guess you're done with the exploration/looking around phase since you've started the implementation
The exploration examined how other repos did it, mainly Bokeh and pydata-sphinx-theme. The current implementation is done to try out what is needed on AWS side of things.
I would like to know if you looked into relying on readthedocs? And if you did and decided not to use it, why?
I haven't given it much thought, but I chose to rely on something more fundamental. I don't have the time to learn a new tool for this task, and I would likely still need some settings in AWS. If we choose to move to another framework in the future, I don't think it would be that hard.
Ok, thanks for the details.
I don't have the time to learn a new tool for this task, and I would likely still need some settings in AWS.
I might be wrong but in my mind readthedocs is a simpler alternative deployment solution to AWS that doesn't require the user to learn about AWS or another cloud provider. It also has a free tier for community projects. So it'd be good if we could motivate why we decided to pick AWS over readthedocs. I have a vague memory that one limit we'd face with readthedocs was that our docs build time was over their limit?
I need to update the hvplot-test.holoviz.org to hvplot.holoviz.org and decide on internationalization, but otherwise, it should be somewhat ready for review.
These two links don't redirect to latest:
- https://hvplot-test.holoviz.org/en/docs/
- https://hvplot-test.holoviz.org/en/docs
We could also redirect https://hvplot-test.holoviz.org/docs to the latest for even more compact url.
We could also redirect https://hvplot-test.holoviz.org/docs to the latest for even more compact url.
Yep that'd be nice for /docs and /docs/ (there's no language called docs right? :) ).
The site is available at d143q6f9lgtjhm.cloudfront.net. I've merged the Google docs into one Wiki https://github.com/holoviz/holoviz/wiki/Website-Versioning.