Welcome to the Kubo documentation!
This repo contains the content for the Kubo documentation, published at https://docs-kubo.cfapps.io. The documentation is currently under development.
The Kubo documentation is published with MkDocs, using a customized version of the Material theme.
MkDocs is a Python application that generates a static web app from Markdown files. Each topic in the Kubo documentation is represented by a Markdown file in the docs directory.
Please help us improve the accuracy and completeness of the Kubo documentation by contributing.
The easiest way to contribute is to file a pull request through GitHub.
To a file a pull request, perform the following steps:
- Locate the pencil icon at the top right of the topic you're looking at.
- Click the pencil icon to navigate to the GitHub page for the corresponding Markdown file.
- Make your changes in the GitHub editor and create a pull request.
You can also create an issue. Issues are repo-wide, so please indicate which topic or topics you are leaving feedback for.
The Kubo documentation is written in Markdown, but it also uses an MkDocs extension called Admonition that enables block-styled side content, such as notes, hints or warnings. See the Admonition documentation for more information about usage.
You can use MkDocs to view a live version of the Kubo documentation on your local machine. This can be useful if you are submitting a pull request with substantial changes to the documentation.
Perform the following steps to preview your changes:
- Install MkDocs on your machine by following the instructions on the MkDocs site.
- Clone this repo:
$ git clone https://github.com/cloudfoundry/docs-kubo.git - Navigate to the repo on your machine.
- Launch the MkDocs development server:
$ mkdocs serve - Navigate to
localhost:8000to see a local version of the documentation. The site will update automatically as you make changes to the Markdown files.