website icon indicating copy to clipboard operation
website copied to clipboard

Documentation Improvements for v0.10.0

Open alexagriffith opened this issue 2 years ago • 0 comments

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

We are working on the KServe 2023 Roadmap https://github.com/kserve/kserve/pull/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 https://github.com/kserve/website/issues/24
  • implement spellcheck in repo https://github.com/kserve/website/issues/82
  • move queue proxy extension documentation to website

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

v0.10

alexagriffith avatar Nov 30 '22 19:11 alexagriffith