https://github.com/kubeslice/docs
The official documentation for Kubeslice project
https://github.com/kubeslice/docs
documentacion kubernetes kubeslice
Last synced: 2 months ago
JSON representation
The official documentation for Kubeslice project
- Host: GitHub
- URL: https://github.com/kubeslice/docs
- Owner: kubeslice
- License: apache-2.0
- Created: 2022-07-04T08:57:14.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-06-23T11:22:32.000Z (6 months ago)
- Last Synced: 2025-06-23T11:42:28.723Z (6 months ago)
- Topics: documentacion, kubernetes, kubeslice
- Language: MDX
- Homepage: https://kubeslice.io
- Size: 6.97 MB
- Stars: 30
- Watchers: 3
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code_of_conduct.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
- Authors: AUTHORS
Awesome Lists containing this project
README
# Kubeslice Documentation
Kubeslice Docs is the documentation repository for [Kubeslice](https://github.com/kubeslice), a Kubernetes management platform that simplifies cluster operations and application deployments. Kubeslice Docs contains the source files for the [Kubeslice documentation website](https://docs.kubeslice.io/), which provides comprehensive guides, tutorials, and reference materials for Kubeslice users and contributors.
## Prerequisites
To use this website, you need
- [Git](https://git-scm.com/downloads)
- [Nodejs version 16.14 or greater](https://nodejs.org/en/download/)
- [Docusaurus](https://docusaurus.io/docs/installation)
## Features
- Written in Markdown, a lightweight and easy-to-use syntax for styling your writing
- Built with [Docusaurus](https://docusaurus.io/docs/installation), a modern static website generator for documentation
- Supports multiple versions
- Includes a search function powered by [Algolia](https://www.algolia.com/)
## Installation
### 1. Fork the Repository
Go to the project repository on Github and click the **Fork** button. On this forked copy you can try new ideas.
### 2. Clone the Project
Get the link of your forked repository and clone the repository using git clone.
```
git clone https://github.com//.git
```
### 3. Change the Directory
Navigate to the directory that contains the project.
```
cd
```
### 4. Install the Node Modules
The following command installs all the dependencies of the project in the local `node_modules` folder.
```
npm install
```
## Local Development
The following command starts a local development server and opens up a browser window. The changes are reflected in real time
without the need to restart the server.
```
npm run start
```
## Contribution
We welcome and appreciate any contributions to Kubeslice Docs. Whether you want to fix a typo, improve the wording, add a new section, or translate the documentation to another language, your help is valuable and appreciated.
Before you start contributing, please read our [Code of Conduct] and [Contribution Guidelines]. They will help you understand our expectations and standards for the Kubeslice community and project.
To contribute to Kubeslice Docs, you can follow these steps:
- Fork this repository and create a new branch for your changes
- Make your changes in your local repository and commit them with a clear and descriptive message
- Push your changes to your forked repository on GitHub
- Create a pull request from your fork to the main repository, and fill in the template with the details of your changes
- Wait for the review and feedback from the maintainers, and address any comments or suggestions they may have
- Once your pull request is approved and merged, your changes will be reflected on the documentation website
Thank you for your interest and support for Kubeslice Docs! 🙌