KServe documentation

Welcome to the source file repository for our documentation on https://kserve.github.io/website/

Website

The KServe documentation website is built using Material for MkDocs.

View published documentation

View all KServe documentation and walk-through our code samples on the website.

The KServe website includes versioned docs for recent releases, the KServe blog, links to all community resources, as well as KServe governance and contributor guidelines.

Run website locally

For instructions, see KServe's MkDocs contributor guide.

Website source files

Source files for the documentation on the website are located within the /docs directory of this repo.

Documentation versions for KServe releases

Each release of the KServe docs is available in the website (starting with 0.3) and their source files are all stored in branches of this repo.

Contributing to docs

We're excited that you're interested in contributing to the KServe documentation! Check out the resources below to get started.

Getting started

If you want to contribute a fix or add new content to the documentation, you can navigate through the /docs repo or use the Edit this page pencil icon on each of the pages of the website.

Before you can contribute, first start by reading the KServe contributor guidelines and learning about our community and requirements. In addition to reading about how to contribute to the docs, you should take a moment to learn about the KServe code of conduct, governance, values, and the KServe working groups and committees.

KServe community and contributor guidelines

Source files for all KServe community and governance topics are located separately in the kserve/community repo.

To help you get started, see the following resources:

• KServe docs contributor's guide -- Contains information about how to contribute.

• New content templates:

  • Concept
  • Procedure
  • Troubleshooting
  • Blog

Help and support

Your help and feedback is always welcome!

If you find an issue let us know, either by clicking the Create Issue on any of the website pages, or by directly opening an issue here in the repo.

If you have a question that you can't find an answer to, we would also like to hear about that too. In addition to our docs, you can also reach out to the community for assistance.