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

Moving documentation to docs.rapids.ai #579

Closed
charlesbluca opened this issue Apr 19, 2021 · 9 comments
Closed

Moving documentation to docs.rapids.ai #579

charlesbluca opened this issue Apr 19, 2021 · 9 comments
Labels
2 - In Progress Currently a work in progress doc Documentation gpuCI gpuCI issue

Comments

@charlesbluca
Copy link
Member

charlesbluca commented Apr 19, 2021

After some internal discussion, we have decided to move the documentation of Dask-CUDA from Read the Docs to RAPIDS Docs. This would make it relatively easy to set up a docs CI workflow script like this, and is motivated by the fact that there are a lot of barriers keeping this repo from migrating to Dask org.

What's a clean way to do this without causing confusion? Should we keep both sites up simultaneously for a period of time with some banner notifying the migration? Or have the RTD docs redirect straight to the RAPIDS docs?

cc @quasiben @pentschev

@charlesbluca charlesbluca added 0 - Backlog In queue waiting for assignment doc Documentation gpuCI gpuCI issue labels Apr 19, 2021
@charlesbluca charlesbluca added 2 - In Progress Currently a work in progress and removed 0 - Backlog In queue waiting for assignment labels Apr 19, 2021
@charlesbluca
Copy link
Member Author

Opened #580 to make a gpuCI docs build script.

@pentschev
Copy link
Member

Redirecting seems like a simpler way to deal with it.

@charlesbluca
Copy link
Member Author

I agree, just wasn't sure if RTD had the ability to easily manage a redirect but looks like it can.

rapids-bot bot pushed a commit that referenced this issue Apr 22, 2021
Adds a docs build script for gpuCI to execute on merges; addresses #579.

Depends on rapidsai/integration#250

cc @quasiben

Authors:
  - Charles Blackmon-Luca (https://github.com/charlesbluca)

Approvers:
  - Dillon Cullinan (https://github.com/dillon-cullinan)

URL: #580
@github-actions
Copy link

This issue has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this issue if no further response or action is needed. Otherwise, please respond with a comment indicating any updates or changes to the original issue and/or confirm this issue still needs to be addressed. This issue will be labeled inactive-90d if there is no activity in the next 60 days.

@charlesbluca
Copy link
Member Author

Dask-CUDA's docs just got published to RAPIDS docs:

Now we would just want to figure out redirecting the RTD version of the docs.

@jakirkham
Copy link
Member

In conda-forge we did this like so

@charlesbluca
Copy link
Member Author

Great - thanks for that example! Do you know if we would need to keep that rtd/ directory in our repo if we disable webhooks on RTD's end after the last build?

@jakirkham
Copy link
Member

Peter was mentioning redirecting, which agree probably makes sense (there may be other links to RTD out there).

So the rtd directory is important for supplying a documentation build that creates a webpage on RTD to do the redirecting. This is set in the RTD config file. We wouldn't want that in our usual docs hence the separate directory.

rapids-bot bot pushed a commit that referenced this issue May 19, 2021
Taking @jakirkham's [suggestion](#579 (comment)) for handling RTD redirects to an external site.

Authors:
  - Charles Blackmon-Luca (https://github.com/charlesbluca)

Approvers:
  - Peter Andreas Entschev (https://github.com/pentschev)
  - https://github.com/jakirkham

URL: #615
@charlesbluca
Copy link
Member Author

With #615 merged, looks like the redirect is working and the docs migration is complete 😄 thanks for the help @jakirkham @pentschev!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In Progress Currently a work in progress doc Documentation gpuCI gpuCI issue
Projects
None yet
Development

No branches or pull requests

3 participants