Skip to content

Commit

Permalink
Augment the analysis README file with info on writing docs for analyz…
Browse files Browse the repository at this point in the history
…es messages. (istio#17626)
  • Loading branch information
geeknoid authored Oct 7, 2019
1 parent 12a4e2d commit a28c4ca
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions galley/pkg/config/analysis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,14 @@ You can use `istioctl experimental analyze` to run all analyzers, including your
make istioctl && $GOPATH/out/linux_amd64/release/istioctl experimental analyze
```

### 6. Write a user-facing documentation page

Each analysis message needs to be documented for customers. This is done by introducing a markdown file for
each message in the istio.io repo in the content/en/docs/reference/config/analysis directory. You create
a subdirectory with the code of the error message, and add a `index.md` file that contains the
full description of the problem with potential remediation steps, examples, etc. See the existing
files in that directory for examples of how this is done.

## FAQ

### What if I need a resource not available as a collection?
Expand Down

0 comments on commit a28c4ca

Please sign in to comment.