Skip to content
Snippets Groups Projects
Unverified Commit 73f1eaee authored by korvoj's avatar korvoj Committed by GitHub
Browse files

Update README.md with instructions for contributors (#37)

parent a372b890
No related branches found
No related tags found
No related merge requests found
# nmaas-docs
NMaaS Documentation Repository
# 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
git clone https://github.com/nmaas-platform/nmaas-docs
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.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment