README
¶
KitOps Documentation
This is the documentation for KitsOps. You can read the docs at https://kitops.org/docs/overview.html.
Table of Contents
Introduction
This documentation has been built using VitePress.
Development
To get started with our, follow these steps:
Prerequisites
Ensure you have the following installed on your system:
- Node.js (v20.x or higher)
- npm or pnpm package manager (v8.x or higher)
For local development, pnpm is preferred as package manager.
Running locally
- Clone the repository:
git clone https://github.com/kitops-ml/kitops.git - Navigate to the docs directory:
cd docs - Install dependencies:
pnpm i - Start the development server:
pnpm docs:dev
The documentation should now be available at http://localhost:5173.
Building and previewing
To build the docs (from .md to .html):
pnpm docs:build
And to serve the builds files (preview):
pnpm docs:preview
This will serve the just built files in port 4173, so you go to http://localhost:4173 to see exactly what will be served once built and deployed.
Contributing Guidelines
We welcome contributions from the community to help improve our project and documentation. Please read our Guide to Contributing and follow these guidelines:
Reporting Bugs and Issues
If you encounter any bugs or issues with the documentation, please report them in our GitHub issue tracker and add the docs label. Be sure to provide clear details about the problem, including steps to reproduce if possible.
Submitting Pull Requests
If you'd like to submit a pull request for updates or improvements to the documentation, please follow these steps:
- Fork the repository on GitHub.
- Create a new branch for your changes:
git checkout -b feature/your-feature - Make the necessary changes and additions to the documentation.
- Commit your changes:
git commit -m 'Add documentation for XYZ' - Push the branch to your forked repository:
git push origin feature/your-feature - Submit a pull request on GitHub, detailing the changes you made.
Directories