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

docs: Deploy documentation artifacts to S3 #745

Merged
merged 10 commits into from
Dec 2, 2024
Merged

Conversation

thomass-dev
Copy link
Collaborator

@thomass-dev thomass-dev commented Nov 14, 2024

  • 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

@thomass-dev thomass-dev changed the title documentation: Deploy to S3 docs: Deploy documentation artifacts to S3 Nov 14, 2024
@thomass-dev thomass-dev force-pushed the documentation-on-s3 branch 24 times, most recently from 7c4e95a to 4e154ea Compare November 19, 2024 16:57
@thomass-dev thomass-dev force-pushed the documentation-on-s3 branch 2 times, most recently from 47b9d7f to 0e4f482 Compare November 20, 2024 20:28
Copy link
Contributor

@rouk1 rouk1 left a 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).

For reference Skrub does that.
Screenshot 2024-11-26 at 10 10 35

@thomass-dev thomass-dev marked this pull request as draft November 27, 2024 14:58
@thomass-dev thomass-dev force-pushed the documentation-on-s3 branch 7 times, most recently from 73f38d1 to 7566f10 Compare November 28, 2024 15:45
@thomass-dev thomass-dev marked this pull request as ready for review November 28, 2024 15:49
@thomass-dev
Copy link
Collaborator Author

thomass-dev commented Nov 28, 2024

@rouk1 @jerome-probabl i propose to merge this version in state and refactor in a futur iteration with your comments about

  • leaving the python code in a python file,
  • making a canonical link instead of a redirection.

rouk1
rouk1 previously approved these changes Nov 28, 2024
Copy link
Contributor

@rouk1 rouk1 left a comment

Choose a reason for hiding this comment

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

ma-gni-fique 😻

@thomass-dev thomass-dev merged commit 45f04c2 into main Dec 2, 2024
11 checks passed
@thomass-dev thomass-dev deleted the documentation-on-s3 branch December 2, 2024 08:42
thomass-dev added a commit that referenced this pull request Dec 2, 2024
- 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
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants