https://github.com/nmaas-platform/nmaas-docs
NMaaS documentation source for https://docs.nmaas.eu
https://github.com/nmaas-platform/nmaas-docs
docs helm kubernetes mkdocs nmaas
Last synced: 5 months ago
JSON representation
NMaaS documentation source for https://docs.nmaas.eu
- Host: GitHub
- URL: https://github.com/nmaas-platform/nmaas-docs
- Owner: nmaas-platform
- License: apache-2.0
- Created: 2022-06-02T13:19:38.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2026-01-15T15:56:13.000Z (5 months ago)
- Last Synced: 2026-01-15T16:48:28.044Z (5 months ago)
- Topics: docs, helm, kubernetes, mkdocs, nmaas
- Homepage: https://docs.nmaas.eu/
- Size: 29.7 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nmaas Documentation
This repository contains the source files for the [docs.nmaas.eu](https://docs.nmaas.eu) website. It provides information on both the self-hosted nmaas version, as well as the hosted one.
## Contributing to the Documentation
The documentation is built using MkDocs. GitHub workflows have been configured that publish the latest changes from the `master` branch to GitHub pages.
The following steps can be followed to set up a local environment:
1. Fork/Clone the Git repository
2. Create a new Python virtual environment
```bash
sudo apt update && sudo apt install -y virtualenv
git clone git@gitlab.software.geant.org:nmaas/documentation/nmaas-docs.git
cd nmaas-docs
virtualenv -p python3 venv
```
3. Activate the newly created Python virtual environment
```bash
source venv/bin/activate
```
4. Install the dependencies specified in the `requirements.txt` file
```bash
pip install -r requirements.txt
```
5. Start the MkDocs development server
```bash
mkdocs serve
```
6. Make changes to any of the source Markdown files, save them, and preview them using the development server.
7. Push the changes and create a corresponding pull request.