-
Notifications
You must be signed in to change notification settings - Fork 22
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
docs: Deploy documentation artifacts to S3 #745
Conversation
7c4e95a
to
4e154ea
Compare
47b9d7f
to
0e4f482
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we add a stable
folder with the latest version of the documentation (a copy) ?
This could allow us to add a canonical link in our heads sections.
<link rel="canonical" href="https://skore.probabl.ai/stable/" />
I think this is better SEO wise especially as shpinx switcher use permanent redirection (301).
73f38d1
to
7566f10
Compare
7566f10
to
a111752
Compare
@rouk1 @jerome-probabl i propose to merge this version in state and refactor in a futur iteration with your comments about
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ma-gni-fique 😻
3ddb846
to
014b3a0
Compare
- Replace the use of `gh-pages` by S3 bucket: the commits history remains light and clean, - Create a new version of the documentation after each release of `skore`, - Add a drop-down list allowing user to select the last 10 versions (+ `dev`) of the documentation of `skore`, - Running locally `make html` build documentation with a `dev` tag. --- After each __commit__ on the `main` branch, the documentation is build and deployed on the `S3:dev/` directory. After each __release__, the documentation is build and deployed to the `S3:version/` directory, the version being a subpart of the tag `MAJOR.MINOR.BUGFIX`: `MAJOR.MINOR`. For instance, with the following timeline: ``` dev/ dev/ dev/ dev/ dev/ 0.1/ 0.2/ main -- x -- x -- x -- x -- x -- > | | tag 0.1 0.2 ``` The S3 bucket looks like: ``` . ├── 0.1/ ├── 0.2/ ├── dev/ ├── index.html └── versions.json ```
gh-pages
by S3 bucket: the commits history remains light and clean,skore
,dev
) of the documentation ofskore
,make html
build documentation with adev
tag.After each commit on the
main
branch, the documentation is build and deployed on theS3:dev/
directory.After each release, the documentation is build and deployed to the
S3:version/
directory, the version beinga subpart of the tag
MAJOR.MINOR.BUGFIX
:MAJOR.MINOR
.For instance, with the following timeline:
The S3 bucket looks like: