Skip to content

Commit

Permalink
Minor improvements to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
abn committed Jul 23, 2020
1 parent 2a47d50 commit 6c92229
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Contribution Guide
## Guidelines
Be nice. Be respectful.

## Developer Documentation
### Regenerating Protobuf Source
Expand All @@ -16,22 +18,21 @@ correctly).

#### Installation
```sh
# install the shell binary
go get -u github.com/google/gnxi/gnmi_target
go install -v github.com/google/gnxi/gnmi_target
```

#### Sample Configuration
You can use the configuration provided at [tests/integration/fixtures/config.json](tests/integration/fixtures/config.json)
or fetch it using curl.
You can use the provided [sample configuration](tests/integration/fixtures/config.json). If you do not have a local copy
of the repository, fetch it using `curl`.

```sh
# fetch test configuration from github
curl -sLO https://raw.githubusercontent.com/python-gnxi/python-gnmi-proto/master/tests/integration/fixtures/config.json
```

#### Run Server
Once you have a configuration you can start the server like shown below.
```sh
# run server
gnmi_target \
-bind_address ":9339" \
-username admin \
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The default implementation makes use of the [betterproto](https://pypi.org/proje

## Example Usage
### Client
The following code expects a server at `127.0.0.1:9339` with the [test configuration](tests/integration/fixtures/config.json). Refer to [gNMI Target Server](CONTRIBUTING.md#gnmi-target-server) section in [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to set it up.
The following code expects a server at `127.0.0.1:9339` with the [test configuration](https://github.com/python-gnxi/python-gnmi-proto/blob/master/tests/integration/fixtures/config.json). Refer to [gNMI Target Server](https://github.com/python-gnxi/python-gnmi-proto/blob/master/CONTRIBUTING.md#gnmi-target-server) section in [CONTRIBUTING.md](https://github.com/python-gnxi/python-gnmi-proto/blob/master/CONTRIBUTING.md) for information on how to set it up.

#### Using betterproto and grpclib
```py
Expand Down

0 comments on commit 6c92229

Please sign in to comment.