Source repository and contributor guide for the official Knative documentation website.
Knative/docs is the source repository and contributor guide for the official Knative documentation website. It contains all the source files, templates, and instructions for maintaining and contributing to documentation about Knative components, releases, and community resources. The project enables the Knative community to collaboratively create and update technical documentation hosted at knative.dev.
Technical writers, developers, and community contributors who want to create or improve documentation for Knative projects. It's also relevant for users seeking to understand Knative's documentation structure or contribute fixes.
It provides a centralized, version-controlled repository with clear contribution guidelines and templates, ensuring consistent and high-quality documentation for the Knative ecosystem. The integration with community channels and working groups fosters collaborative documentation efforts.
User documentation for Knative components.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Stores source files for all Knative releases in branches, ensuring historical docs are preserved and accessible on knative.dev, as outlined in the 'Documentation versions for Knative releases' section.
Provides specific templates for concepts, procedures, troubleshooting, and blog entries, streamlining consistency and quality, detailed in the 'New content templates' resources.
Allows contributors to run the website locally using Material for MkDocs to preview changes, with instructions linked in the 'Run the website locally' section for easy validation.
Integrates with Knative community resources like Slack channels and working groups, offering direct support and collaboration, referenced in 'Getting help' and community links.
Heavily relies on Material for MkDocs for building the website, which can be a barrier for contributors unfamiliar with this static site generator, as setup requires following external guides.
Key guidelines are split between this repo and knative/community, forcing users to navigate multiple sources to contribute effectively, noted in the 'Contributing to docs' section.
The documentation and templates are tailored specifically for Knative projects, making it less useful for documenting other technologies or general-purpose use cases.