docs: Add versioning to documentation #1533
Conversation
|
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. |
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.
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 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 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? |
hoxbro
force-pushed
the
docs_version
branch
9 times, most recently
from
5ab9416 to
a960525
Compare
| 'json_url': 'https://hvplot-test.holoviz.org/switcher.json', | ||
| 'version_match': switcher_version, | ||
| }, | ||
| 'show_version_warning_banner': True, |
There was a problem hiding this comment.
This will not show anything as the version for the dev build is clean and tested locally with an alpha tag, which shows the warning banner.
| - name: Validate version | ||
| if: ${{ inputs.target == 'main' }} | ||
| run: | | ||
| if [[ -z "$VERSION" || ! "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then | ||
| echo "❌ 'version' is required and must match format X.X.X (e.g. 0.11.1) when target is 'main'" | ||
| exit 1 | ||
| fi |
There was a problem hiding this comment.
Adding this here to fail fast.
hoxbro
changed the title
|
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. |
| (github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'main') || | ||
| (github.event_name == 'push' && !(contains(steps.vars.outputs.tag, 'a') || contains(steps.vars.outputs.tag, 'b') || contains(steps.vars.outputs.tag, 'rc'))) | ||
| uses: peaceiris/actions-gh-pages@v4 | ||
| - uses: holoviz-dev/holoviz_tasks/docs-publish@docs_publish |
There was a problem hiding this comment.
It also needs to be updated when holoviz-dev/holoviz_tasks#44 is merged.
| @@ -52,8 +57,13 @@ | |||
| 'icon': 'fa-brands fa-discord', | |||
| }, | |||
| ], | |||
| 'pygment_dark_style': 'material', | |||
| 'pygments_dark_style': 'material', | |||
There was a problem hiding this comment.
Unrelated to docs versioning
|
These two links don't redirect to latest: |
Those will now redirect |
|
We could also redirect https://hvplot-test.holoviz.org/docs to the latest for even more compact url. |
Yep that'd be nice for |
|
Those also redirect now. |
https://hvplot-test.holoviz.org
TODO: