From 36c7e4e0ac2bd5a7fb64d85e5502c5b486ff63d9 Mon Sep 17 00:00:00 2001 From: Wael Kdouh Date: Tue, 14 Mar 2023 08:45:38 -0400 Subject: [PATCH] documentation refactoring --- docs/README.md | 1 + docs/index.markdown | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/README.md b/docs/README.md index 6ad7b4e..0c4fa5f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,7 @@ # Code Of Conduct Before we dive into learning about the APIOPs tool we would like to share some guidance on how to navigate the associated Github repo as you learn your way around the tool: +- Always refer to the [wiki](https://github.com/Azure/apiops/wiki) for detailed configuration setup - Always use the latest [release](https://github.com/Azure/apiops/releases) which includes the latest features and bug fixes - Please use the [issues](https://github.com/Azure/apiops/issues) section to report any issues that you encounter as well as any requested features that you would like to raise to the development team. Always remember to close your issues when its gets resolved - Remember to subscribe to this repo (at least subscribe to be notified about new releases) to stay in the loop as we are always adding new features and squashing these pesky bugs diff --git a/docs/index.markdown b/docs/index.markdown index 6ad7b4e..0c4fa5f 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -4,6 +4,7 @@ # Code Of Conduct Before we dive into learning about the APIOPs tool we would like to share some guidance on how to navigate the associated Github repo as you learn your way around the tool: +- Always refer to the [wiki](https://github.com/Azure/apiops/wiki) for detailed configuration setup - Always use the latest [release](https://github.com/Azure/apiops/releases) which includes the latest features and bug fixes - Please use the [issues](https://github.com/Azure/apiops/issues) section to report any issues that you encounter as well as any requested features that you would like to raise to the development team. Always remember to close your issues when its gets resolved - Remember to subscribe to this repo (at least subscribe to be notified about new releases) to stay in the loop as we are always adding new features and squashing these pesky bugs