[DOC] Add enterprise packaging, ABI stability, and implications to docs
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
Vendors and users who ultimately want to benefit from our new build and enterprise support strategy ultimately need to make some considerations when integrating cuVS- for example, rather than building and packaging cuvs directly, they'll need to use our upcoming tarball packaging and assume their users will be installing cuvs separately. They'll also need to use our C APIs or any of the API wrappers built on top of it, rather than using C++ direclty.
The reasoning behind these implications is not immediately obvious for most users, so we should add a section to our docs explaining why these are important, their implications, the plans and guarantees, etc... so that we can point users to a consistent and cohesive (public) messaging.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No documentation file or test is named in the issue, so first locate the existing public documentation and the current packaging and ABI guidance. The work is done when a cohesive section explains the rationale, implications, plans, and guarantees for tarball packaging and using the C APIs or their wrappers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100