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

Documentation Improvements for v0.10.0 #204

Open
alexagriffith opened this issue Nov 30, 2022 · 0 comments
Open

Documentation Improvements for v0.10.0 #204

alexagriffith opened this issue Nov 30, 2022 · 0 comments

Comments

@alexagriffith
Copy link
Contributor

alexagriffith commented Nov 30, 2022

What is changing? (Please include as many details as possible.)

We are working on the KServe 2023 Roadmap kserve/kserve#2526 and the v0.10.0 release, as well as preparing for our eventual v1.0 😄 . For all of this and to keep up with our changes, we need to improve our documentation and website!

Here are the current objectives to improve the Kserve website documentation

  • Unify the data plane v1 and v2 page formats (one has table one has long form text)
  • Improve the v2 page to be more succinct and clearly show what can be used by splitting the page into two: (1) that tells the story of why and what changed and (2) to explain how to use v2 and what it provides
  • document fastapi updates for model server
  • document serving runtime spec changes
  • clean up the examples in kserve repo and unify them with the website's by creating one source of truth for example documentation
  • update any out-of-date documentation and make sure the website as a whole is consistent and cohesive
  • add monitoring setup documentation & documentation for knative serverless install Add monitoring doc for knative serverless install #24
  • implement spellcheck in repo Run spelling checks for website repo #82
  • move queue proxy extension documentation to website

In what release will this take happen (to the best of your knowledge)?

v0.10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant