post-processing: fix version map, use pre-commit to regenerate it #669
Conversation
✅ Deploy Preview for docs-rapids-ai ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| autoupdate_schedule: quarterly | ||
| skip: | ||
| # requires 'jq' and 'yq', which dont' come pre-installed in the pre-commit.ci image | ||
| - generate-projects-to-versions |
There was a problem hiding this comment.
This was something I hadn't considered when implementing this in a shell script and then introducing a pre-commit hook... for language: system types of hooks, you have to manage your own dependencies (https://pre-commit.com/#system).
And on pre-commit.ci, we don't have any ability (as far as I can tell) to pre-install things before pre-commit runs.
For now, to restore all the API docs, let's just skip this in CI.
I can put up a follow-up switching this to a Python script... that'd be easier to maintain anyway 😁
bdice
left a comment
bdice
left a comment
There was a problem hiding this comment.
Approving with a couple of suggestions
| cugraph: | ||
| name: cuGraph | ||
| path: cugraph | ||
| desc: 'cuGraph is a GPU accelerated graph analytics library, with functionality like NetworkX, which is seamlessly integrated into the RAPIDS data science platform. cuGraph supports GNNs with PyG, DGL packages, cugraph-service for analytics on a remote graph, and WHOLEGRAPH for memory management.' |
There was a problem hiding this comment.
Non-blocking: This needs to be updated, the GNN functionality has been split out.
There was a problem hiding this comment.
I'll address this in a follow-up... it does need to be updated (to remove DGL and to mention the specific library names for searchability), but not because the GNN functionality has been split out.
The whole family of cugraph packages builds its docs from one repo: https://github.com/rapidsai/cugraph-docs
Instead of uploading from individual projects' CI like the rest of RAPIDS. That is also why you don't see a separate entry for nx-cugraph in https://github.com/rapidsai/docs/blob/main/_data/docs.yml, I think.
I'll put up a follow-up with a proposal we can discuss.
cc @acostadon
Co-authored-by: Bradley Dice <bdice@bradleydice.com>
Follow-up to fix the issues noted in #657 (comment)
In #657, I accidentally removed some projects (like
cucim,cuxfilter, andrmm) from https://docs.rapids.ai/api/, via a mix of a bad merge conflict resolution and mistakes made reading the diff.This fixes that, by restoring the dropped entries in
_data/docs.yml.It also proposes changes to prevent this type of thing from slipping through in the future:
projects-to-versions.jsoninto source controlpre-commithook to regenerate itrapids-medataand it's been very helpful there (code link)Notes for Reviewers
How I tested this
Re-generated the docs site locally, following the docs at
docs/CONTRIBUTING.md
Line 37 in b04146f
Confirmed that every expected library was downloaded, the processing worked for all of them, and the API docs pages rendered correctly.
I also tried manually changing entries in
releases.json,docs.yml, andprojects-to-versions.json, then runningIn all cases, I saw the hook correctly update that file.