From 3a5d64afb9937747b177946a2de72c18e7cd2b66 Mon Sep 17 00:00:00 2001 From: Bryan Behrenshausen Date: Wed, 9 Oct 2024 10:27:56 -0400 Subject: [PATCH] Update readme with required sections (#686) * docs: update readme Signed-off-by: Bryan Behrenshausen --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f1bf2b8d..90574a5a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # SAS® Viya® Monitoring for Kubernetes - -SAS® Viya® Monitoring for Kubernetes provides scripts and customization -options to deploy metric monitoring, alerts, and log-message aggregation for SAS® Viya®. +## Overview +SAS® Viya® Monitoring for Kubernetes provides scripts and customization options to deploy metric monitoring, alerts, and log-message aggregation for SAS® Viya®. **Note:** The documentation included in this GitHub project uses "SAS Viya" to refer to the SAS Viya platform and compatible SAS Viya applications, including these products: - SAS® Viya® (previously called SAS Visual Machine Learning) @@ -14,5 +13,11 @@ Log monitoring and metric monitoring can be deployed independently or together. For information about SAS® Viya® Monitoring for Kubernetes, see the following sections in the SAS Viya Monitoring for Kubernetes Help Center: - For an introduction, see [About SAS® Viya® Monitoring for Kubernetes](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n0bzfdp3bn6p4vn1lj9pm2hy8t0q.htm). +- For information about the components in SAS® Viya® Monitoring for Kubernetes, the prerequisites, and more, see [Getting Started](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n18d875xbudfken18v75gj7mopxq.htm) in the SAS Viya Monitoring for Kubernetes Help Center. + +## Contributing +Maintainers are accepting patches and contributions to this project. +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on submitting contributions to this project. -- For information about the components in SAS® Viya® Monitoring for Kubernetes, the prerequisites, and more, see [Getting Started](https://documentation.sas.com/?cdcId=obsrvcdc&cdcVersion=v_003&docsetId=obsrvdply&docsetTarget=n18d875xbudfken18v75gj7mopxq.htm) in the SAS Viya Monitoring for Kubernetes Help Center. \ No newline at end of file +## License +This project is licensed under the [Apache 2.0 License](LICENSE).