Follow suggestions by @munnerz, add docs about the bazel targets to run.

Signed-off-by: Evan Anderson <evan.k.anderson@gmail.com>
This commit is contained in:
Evan Anderson 2018-10-09 06:31:17 -07:00
parent 063dcce978
commit ec49d971ae
2 changed files with 4 additions and 11 deletions

View File

@ -35,7 +35,6 @@ Install local development tools
You will need the following tools to build cert-manager:
* Go_ (You may need a newer version than ships with your distro)
* Bazel_
* Docker_ (and enable for non-root user)
@ -44,13 +43,12 @@ require further changes.
If you need to add dependencies, you will additionally need:
* Dep_
* Gazelle_
* Kazel_
* Buildozer_
* Git_
* Mercurial_
You can then run ``bazel run //hack:update-deps`` to regenerate any
dependencies, and ``bazel build :images`` to build the docker images.
Build a dev version of cert-manager
===================================
@ -95,12 +93,7 @@ However, if you make changes to the helm chart or wish to change the controller'
./contrib/charts/cert-manager
.. _Go: https://golang.org/
.. _Bazel: https://docs.bazel.build/versions/master/install.html
.. _Docker: https://store.docker.com/search?type=edition&offering=community
.. _Dep: https://github.com/golang/dep
.. _Gazelle: https://github.com/bazelbuild/bazel-gazelle
.. _Kazel: https://github.com/kubernetes/repo-infra/tree/master/kazel
.. _Buildozer: https://github.com/bazelbuild/buildtools/tree/master/buildozer
.. _Git: https://git-scm.com/downloads
.. _Mercurial: https://www.mercurial-scm.org/

View File

@ -3,7 +3,7 @@ Generating Documentation
=====================
The documentation uses `Sphinx`_ (via `Read The Docs`_) to generate markdown
rom `reStructured Text`_.
from `reStructured Text`_.
Installation instructions
=========================