rapidsai / docs

RAPIDS Documentation Site
https://docs.rapids.ai
37 stars 52 forks source link

Migrate docs.rapids.ai into rapids.ai framework #388

Open exactlyallan opened 1 year ago

exactlyallan commented 1 year ago

Based on proposal - https://docs.google.com/presentation/d/1-N1f5JJArDzcMdxveoJtKeziz0hldBdTtL2wvY6DiqM/edit#slide=id.p

### Tasks
- [ ] Push doxygen docs to build into sphinx with breathe @ajschmidt8 to assist
- [x] Create external RAPIDS theme based on PyData Theme + Nav @jacobtomlinson and @exactlyallan  rapidsai/docs#379
- [ ] Create docs style and content guide - @exactlyallan
- [ ] Migrate Quasi-docs (I.E. viz guide) from Jekyll into Hugo in Rapids.ai @exactlyallan
- [x] Setup domain forwarding and check S3 dir structure
- [ ] https://github.com/rapidsai/rapids.ai/issues/346
ajschmidt8 commented 1 year ago

There are some additional backend changes that I'm working with @AyodeAwe on to enable this migration.

Namely setting up a CloudFront Distribution in front of the S3 bucket that has all of the docs and enabling Netlify's proxy feature to work correctly with that CloudFront Distribution.

We're also brainstorming on ways to enable PR previews for docs builds so that the individual repos (e.g. cudf, cuml, etc) can see what their doc changes look like before merging PRs.

ajschmidt8 commented 1 year ago

@exactlyallan, quick side note. We should also try to move the viz guide to S3 and use proxying for that too since the JSON files are relatively large.

I think the last time I checked, they were contributing around ~100MB to the git history for the docs repository.

jacobtomlinson commented 1 year ago

We're also brainstorming on ways to enable PR previews for docs builds so that the individual repos (e.g. cudf, cuml, etc) can see what their doc changes look like before merging PRs.

We have Read the Docs enabled on the deployment repo, just for the PR previews. In the Dask Blog we use Netlify for previews. In both cases neither actually gets deployed to the service that provides the previews.

exactlyallan commented 1 year ago

Note: Merged PR kicks off GHA to build docs and push to S3 bucket with version folder i.e. https://d1664dvumjb44w.cloudfront.net/cudf/23.04/html/