Skip to content

Commit

Permalink
docs: update contibutor docs (kubernetes-sigs#2961)
Browse files Browse the repository at this point in the history
  • Loading branch information
prasadkatti authored Jan 9, 2023
1 parent e3c81db commit a6a09f6
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ _As contributors and maintainers of this project, and in the interest of fosteri
### Building the project
[Controller developement documentation](/docs/controller-devel.md) has instructions on how to build the project and project specific expectations.

### Contributing to docs

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 -

- Install [pipenv](https://pipenv.pypa.io/en/latest/install/#installing-pipenv)
- run `make docs-preview`. This will generate and serve docs locally at http://127.0.0.1:8000

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

## Contact Information

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

0 comments on commit a6a09f6

Please sign in to comment.