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

Initial Docs Site Content Migration #358

Draft
wants to merge 50 commits into
base: main
Choose a base branch
from

Conversation

ajschmidt8
Copy link
Member

This PR is a first pass at migrating the content from docs.rapids.ai into rapids.ai.

@bdice
Copy link
Contributor

bdice commented Feb 27, 2024

@ajschmidt8 @exactlyallan What is the status / future plans for this work?

@ajschmidt8
Copy link
Member Author

@ajschmidt8 @exactlyallan What is the status / future plans for this work?

@bdice this is still in progress. Allan and I work on it as time permits. Jordan is taking off a week in March, so I was planning on revisiting this then.

Copy link

vercel bot commented Sep 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
rapids-ai ✅ Ready (Inspect) Visit Preview Sep 26, 2024 4:43pm

@ajschmidt8
Copy link
Member Author

ajschmidt8 commented Sep 19, 2024

To Do (from my local notes of past conversations with @exactlyallan):

  • Fix any obvious remaining styling/content issues
    • /docs/ and /user-guides/visualization/ (among others)
    • remove {% include *.html %} statements since they are only valid for Jekyll, not Hugo
  • Move dedicated /user-guides/ path into the a sub-section of /docs/
  • Replace any docs.rapids.ai links w/ relative links
  • Proofread all frontmatter
    • remove permalink frontmatter since it's only valid for Jekyll, not Hugo
    • remove any other extraneous frontmatter
  • Remove extraneous content/notices/notices.md file
  • Ensure only one H1 tag per page
  • Ensure media is copied over from docs site (e.g. reproducing CI pictures)
  • Merge latest changes from docs site
  • Ensure licenses from rapids.ai/docs repo are handled correctly (https://github.com/rapidsai/docs/tree/main/licenses)
  • Update all existing RAPIDS notice files to use URL slugs instead of random meaningless numbers
  • Prepare a PR for the docs site that removes all content and sets up redirects to this main site
    • The README on that repo should also be updated to reflect the changes
  • Update releases.yaml: https://github.com/ajschmidt8/rapids.ai/blob/docs-migration/data/releases.yaml
  • Ensure a releases.json file gets published for this: https://github.com/rapidsai/ops-bot/blob/14172f1d52cc50d99fdc11f87eca680e68ccd441/src/plugins/BranchChecker/check_pr.ts#L92
    • Open up a PR preparing that repository for the new file format

I have some other enhancements in my local notes, but I think this covers everything for the first MVP.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In Progress Currenty a work in progress 5 - DO NOT MERGE Hold off on merging; see PR for details
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants