https://github.com/kserve/website

User documentation for KServe.
https://github.com/kserve/website

canary-deployment cloud-native documentation drift-detection explainable-ai hacktoberfest hacktoberfest2023 inference machine-learning mlops serverless

Last synced: 7 days ago
JSON representation

User documentation for KServe.

• Host: GitHub
• URL: https://github.com/kserve/website
• Owner: kserve
• License: apache-2.0
• Created: 2021-06-18T20:57:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T03:00:12.000Z (16 days ago)
• Last Synced: 2024-10-28T06:12:21.783Z (16 days ago)
• Topics: canary-deployment, cloud-native, documentation, drift-detection, explainable-ai, hacktoberfest, hacktoberfest2023, inference, machine-learning, mlops, serverless
• Language: HTML
• Homepage: https://kserve.github.io/website/
• Size: 105 MB
• Stars: 105
• Watchers: 11
• Forks: 121
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://squidfunk.github.io/mkdocs-material/).

### View published documentation

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

[website](https://kserve.github.io/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](docs/help/contributor/mkdocs-contributor-guide.md).

### Website source files

Source files for the documentation on the website are located within the

[`/docs`](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. Take a look at

the [release process](https://github.com/kserve/kserve/blob/master/release/RELEASE_PROCESS_v2.md)

for more information.

## 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`](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](https://github.com/kserve/kserve/blob/master/CONTRIBUTING.md).

Source files for all KServe community and governance topics are located

separately in the [kserve/community](docs/community/)

repo.

To help you get started, see the following resources:

- [KServe docs contributor's guide](docs/help/contributor/) -- Contains information about how

  to contribute.

- New content templates:

  - [Concept](docs/help/contributor/templates/template-concept.md)

  - [Procedure](docs/help/contributor/templates/template-procedure.md)

  - [Troubleshooting](docs/help/contributor/templates/template-troubleshooting.md)

  - [Blog](docs/help/contributor/templates/template-blog.md)

## 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](https://github.com/kserve/website/issues/new/choose) 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.