Skip to content

Commit a6a09f6

Browse files
authored
docs: update contibutor docs (#2961)
1 parent e3c81db commit a6a09f6

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ _As contributors and maintainers of this project, and in the interest of fosteri
99
### Building the project
1010
[Controller developement documentation](/docs/controller-devel.md) has instructions on how to build the project and project specific expectations.
1111

12+
### Contributing to docs
13+
14+
The [documentation](https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/) is generated using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). In order to generate and preview docs locally, use the steps below -
15+
16+
- Install [pipenv](https://pipenv.pypa.io/en/latest/install/#installing-pipenv)
17+
- run `make docs-preview`. This will generate and serve docs locally at http://127.0.0.1:8000
1218

1319
### Contributing
1420
We also have more documentation on how to get started contributing here:
@@ -23,5 +29,5 @@ We also have more documentation on how to get started contributing here:
2329

2430
## Contact Information
2531

26-
- [Slack channel](https://kubernetes.slack.com/messages/sig-aws)
32+
- [Slack channel](https://kubernetes.slack.com/messages/provider-aws)
2733
- [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-aws)

0 commit comments

Comments
 (0)