mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-09-08 20:50:24 +00:00
address issue #1488; clean up linewrap and some minor editing issues in the docs/design/* tree
Signed-off-by: mikebrow <brownwm@us.ibm.com>
This commit is contained in:
@@ -33,7 +33,8 @@ Documentation for other releases can be found at
|
||||
<!-- END MUNGE: UNVERSIONED_WARNING -->
|
||||
This directory contains diagrams for the clustering design doc.
|
||||
|
||||
This depends on the `seqdiag` [utility](http://blockdiag.com/en/seqdiag/index.html). Assuming you have a non-borked python install, this should be installable with
|
||||
This depends on the `seqdiag` [utility](http://blockdiag.com/en/seqdiag/index.html).
|
||||
Assuming you have a non-borked python install, this should be installable with:
|
||||
|
||||
```sh
|
||||
pip install seqdiag
|
||||
@@ -43,7 +44,8 @@ Just call `make` to regenerate the diagrams.
|
||||
|
||||
## Building with Docker
|
||||
|
||||
If you are on a Mac or your pip install is messed up, you can easily build with docker.
|
||||
If you are on a Mac or your pip install is messed up, you can easily build with
|
||||
docker:
|
||||
|
||||
```sh
|
||||
make docker
|
||||
@@ -51,13 +53,18 @@ make docker
|
||||
|
||||
The first run will be slow but things should be fast after that.
|
||||
|
||||
To clean up the docker containers that are created (and other cruft that is left around) you can run `make docker-clean`.
|
||||
To clean up the docker containers that are created (and other cruft that is left
|
||||
around) you can run `make docker-clean`.
|
||||
|
||||
If you are using boot2docker and get warnings about clock skew (or if things aren't building for some reason) then you can fix that up with `make fix-clock-skew`.
|
||||
If you are using boot2docker and get warnings about clock skew (or if things
|
||||
aren't building for some reason) then you can fix that up with
|
||||
`make fix-clock-skew`.
|
||||
|
||||
## Automatically rebuild on file changes
|
||||
|
||||
If you have the fswatch utility installed, you can have it monitor the file system and automatically rebuild when files have changed. Just do a `make watch`.
|
||||
If you have the fswatch utility installed, you can have it monitor the file
|
||||
system and automatically rebuild when files have changed. Just do a
|
||||
`make watch`.
|
||||
|
||||
|
||||
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||
|
Reference in New Issue
Block a user