Skip to content

Commit

Permalink
docs: add documentation on docs setup
Browse files Browse the repository at this point in the history
  • Loading branch information
anonrig committed Jun 25, 2021
1 parent 43f3248 commit dc4cdaf
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## Documentation

Requirements are:
- Protoc
- `brew install protoc`
- Go
- `brew install go`
- Protoc-doc-gen
- `go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc`

### Installation

- **Install dependencies**
- *(This command will run scripts/generate.js which will automatically copy the Helm definition to correct place and produce openapi.json inside `static` folder)*
```bash
$ npm install
```

- **Generate Proto JSON definitions**

```bash
$ protoc --doc_out=./static/fixtures --doc_opt=json,proto_workspace.json --proto_path=../protofiles ../protofiles/**/*.proto
```

- **Generate Proto Markdown**

```bash
$ npx docusaurus generate-proto-docs
```

### Run

```bash
$ npm run start
```

### Build & Bundle

```bash
$ npm run build
```

0 comments on commit dc4cdaf

Please sign in to comment.