1# Contributing
2
3## Process
4
5### Fixing Issues
6
71. Open an Issue on [kubernetes/kubectl](https://github.com/kubernetes/kubectl/issues) repository
81. Edit files under [kubernetes/kubernetes/tree/master/staging/src/k8s.io/kubectl/docs/book](https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/kubectl/docs/book)
91. Create a PR on [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) repository
101. Email PR to kubernetes-sig-cli@googlegroups.com with subject `Kubectl Book: Fix Issue <Issue> in <PR>`
111. Optional: Come to sig-cli meeting to discuss
12
13### Adding New Content
14
151. Open an Issue with proposed content on [kubernetes/kubectl](https://github.com/kubernetes/kubectl/issues) repository
161. Email kubernetes-sig-cli@googlegroups.com with subject `Kubectl Book: Proposed Content <Issue>`
171. Optional: Come to sig-cli meeting to discuss
18
19## Editing
20
21### Running Locally
22
23- Install [GitBook Toolchain](https://docs.gitbook.com/)
24- From `docs/book` run `npm install`  to install node_modules locally (don't run install, it updates the shrinkwrap.json)
25- From `docs/book` run `gitbook serve`
26- Go to `http://localhost:4000` in a browser
27
28### Adding a Section
29
30- Update `SUMMARY.md` with a new section formatted as `## Section Name`
31
32### Adding a Chapter
33
34- Update `SUMMARY.md` under section with chapter formatted as `* [Name of Chapter](pages/section_chapter.md)`
35- Add file `pages/section_chapter.md`
36
37### Adding Examples to a Chapter
38
39```bash
40{% method %}
41Text Explaining Example
42{% sample lang="yaml" %}
43Formatted code
44{% endmethod %}
45```
46
47### Adding Notes to a Chapter
48
49```bash
50{% panel style="info", title="Title of Note" %}
51Note text
52{% endpanel %}
53```
54
55Notes may have the following styles:
56
57- success
58- info
59- warning
60- danger
61
62### Building and Publishing a release
63
64- Run `gitbook build`
65- Push fies in `_book` to a server
66
67### Adding GitBook plugins
68
69- Update `book.json` with the plugin
70- Run `npm install <npm-plugin-name>`
71
72### Cool plugins
73
74See https://github.com/swapagarwal/awesome-gitbook-plugins for more plugins.