Skip to content

Commit

Permalink
Merge pull request #58 from mlinfra-io/update-contribution-docs-again
Browse files Browse the repository at this point in the history
Updated contribution docs
  • Loading branch information
aliabbasjaffri authored Jan 31, 2024
2 parents 89c6f02 + eea2e70 commit 7de9498
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ as well as any project-related communication through discussions.
- To get started, first pat yourself!

- `mlinfra` is organised as follows:
- `mlinfra` cli, all terraform modules and docs are in the `mlinfra` repo
- Generated docs are in `mlinfra.io` repo but the source code is in `mlinfra` repo.
- Docs are in `docs` folder and are built using [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
- Python code can be located in `src/mlinfra` repo
- All terraform modules can be found in `src/mlinfra/modules` folder.

- Fork the `mlinfra` repo and clone it to your local machine.
- Create a python virtual environment and install the dependencies:
Expand All @@ -21,12 +22,11 @@ source venv/bin/activate
pip install -e .

```
- To update the docs, fork the repo `mlinfra` and clone it to your local machine.
- Next, you'd need to first install the docs dependencies:
- To update the docs, you'd need to first install the docs dependencies:
```bash
pip install -r requirements-docs.txt
```
- go to `mlinfra/docs` and run `mkdocs serve` to view the docs locally.
- go to `mlinfra` root and run `mkdocs serve` to view the docs locally.

## Types of Contributions

Expand Down

0 comments on commit 7de9498

Please sign in to comment.