Skip to content

Commit

Permalink
Efficiently reorganize the whole documentation (1)...
Browse files Browse the repository at this point in the history
  • Loading branch information
scuzzilla committed Jan 17, 2023
1 parent 87f4cea commit ecc0482
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
[![Build status](https://github.com/scuzzilla/mdt-dialout-collector/workflows/ci/badge.svg?branch=main)](https://github.com/scuzzilla/mdt-dialout-collector/actions)

**mdt-dialout-collector** is leveraging the [**gRPC Framework**](https://grpc.io/) to implement a multi-vendor gRPC Dial-out collector.
The [doc/Changelog](https://github.com/scuzzilla/mdt-dialout-collector/blob/reorgdoc/doc/Changelog) file is including additional details about the supported vendors.
The [doc/Changelog](https://github.com/scuzzilla/mdt-dialout-collector/blob/main/doc/Changelog) file is including additional details about the supported vendors.

The collector functionalities can be logically grouped into three categories:

1. **Data Collection** - they are steering the daemon(s) behavior.
2. **Data Manipulation** - they are conveniently transforming the in-transit data-stream.
3. **Data Delivery** - they are inter-connecting the collector with the next stage in the pipeline.

The [doc/CONFIG-KEYS](https://github.com/scuzzilla/mdt-dialout-collector/blob/reorgdoc/doc/CONFIG-KEYS) file is including the description for each one of the available options.
The [doc/CONFIG-KEYS](https://github.com/scuzzilla/mdt-dialout-collector/blob/main/doc/CONFIG-KEYS) file is including the description for each one of the available options.

## Deployment

Expand Down Expand Up @@ -74,7 +74,7 @@ DEFAULT: none

## Build/Install

[install.sh](https://github.com/scuzzilla/mdt-dialout-collector/blob/reorgdoc/install.sh) is automating the build/install process, taking care of all [dependencies](https://github.com/scuzzilla/mdt-dialout-collector/blob/reorgdoc/doc/Dependencies).
[install.sh](https://github.com/scuzzilla/mdt-dialout-collector/blob/main/install.sh) is automating the build/install process, taking care of all [dependencies](https://github.com/scuzzilla/mdt-dialout-collector/blob/main/doc/Dependencies).

- The Standalone binary can be deployed using:
```SHELL
Expand Down
2 changes: 1 addition & 1 deletion doc/Changelog
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The keys used are:
!: fixed/modified feature, -: deleted feature, +: new feature

v1.0.0 -- XX-XX-XXXX
v1.0.0 -- 29-09-2022
+ Introduced gRPC dial-out support for Cisco XR/XE (testing devices: Cisco-XR 7.4.1@NCS-540 | Cisco-XE 17.06.01prd7@C8000V)
(https://github.com/ios-xr/model-driven-telemetry/blob/ebc059d77f813b63bb5a3139f5178ad11665d49f/protos/66x/mdt_grpc_dialout/mdt_grpc_dialout.proto)
+ Introduced GPB-KV encoding capabilities for Cisco XR/XE (testing devices: Cisco-XR 7.4.1@NCS-540 | Cisco-XE 17.06.01prd7@C8000V)
Expand Down

0 comments on commit ecc0482

Please sign in to comment.