Merge pull request #205 from lzchen/docs

Author: lzchen

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Updated main and distro READMEs
+    ([#205](https://github.com/microsoft/ApplicationInsights-Python/pull/205))
+
 ## [1.0.0b8](https://github.com/microsoft/ApplicationInsights-Python/releases/tag/v1.0.0b8) - 2022-09-26
 
 - Changing instrumentation dependencies to ~=0.33b0

CONTRIBUTING.md

@@ -38,4 +38,4 @@ instructions provided by the bot. You will only need to do this once across all
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
-or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

README.md

@@ -1,4 +1,15 @@
-# Appliation Insights Python SDK
+# Application Insights for Python
 
-This repo currently holds a single package, `azure-monitor-opentelemetry-distro`. For more information about this package, see the associated [README](https://github.com/microsoft/ApplicationInsights-Python/blob/main/azure-monitor-opentelemetry-distro/README.md).
+This repository holds components that enable telemetry scenarios for your Python applications to send to [Azure Application Insights][azure_application_insights].
 
+Below is the list of components that are within this repository:
+
+[Azure Monitor OpenTelemetry Distro][azure-monitor-opentelemetry-distro].
+
+## Contributing
+
+For information about contributing to this repository, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+<!-- LINKS -->
+[azure_application_insights]: https://azure.microsoft.com/documentation/articles/app-insights-overview/
+[azure-monitor-opentelemetry-distro]: https://github.com/microsoft/ApplicationInsights-Python/blob/main/azure-monitor-opentelemetry-distro/README.md

azure-monitor-opentelemetry-distro/README.md

@@ -11,6 +11,14 @@ This distro automatically installs the following libraries:
 
 ## Getting started
 
+### Key Concepts
+
+This package is simply a collection of OpenTelemetry and Azure Monitor components bundled together to enable the collection and sending of telemetry to Azure Monitor. For MANUAL instrumentation, it is equivalent to installing the above packages individually. AUTOMATIC instrumentation is not yet supported.
+
+The [Azure Monitor OpenTelemetry exporters][azure_monitor_opentelemetry_exporters] are the main components in accomplishing this. You will be able to use the exporters and their APIs directly through this package. Please go the exporter documentation to understand how OpenTelemetry and Azure Monitor components work in enabling telemetry collection and exporting.
+
+Currently, all instrumentations available in OpenTelemetry are in a beta state, meaning they are not stable and may have breaking changes in the future. Efforts are being made in pushing these to a more stable state.
+
 ### Install the package
 
 Install the Azure Monitor Opentelemetry Distro with [pip][pip]:
@@ -23,19 +31,21 @@ pip install azure-monitor-opentelemetry-distro --pre
 To use this package, you must have:
 * Azure subscription - [Create a free account][azure_sub]
 * Azure Monitor - [How to use application insights][application_insights_namespace]
-* Opentelemetry SDK - [Opentelemtry SDK for Python][ot_sdk_python]
-* Python 3.6 or later - [Install Python][python]
+* Opentelemetry SDK - [Opentelemetry SDK for Python][ot_sdk_python]
+* Python 3.7 or later - [Install Python][python]
 
 ### Additional documentation
 
 [Azure Portal][azure_portal]
+[OpenTelemetry Python Official Docs][ot_python_docs]
 
 <!-- LINKS -->
 [azure_monitor_opentelemetry_exporters]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/monitor/azure-monitor-opentelemetry-exporter#microsoft-opentelemetry-exporter-for-azure-monitor
 [azure_portal]: https://portal.azure.com
 [azure_sub]: https://azure.microsoft.com/free/
 [application_insights_namespace]: https://docs.microsoft.com/azure/azure-monitor/app/
 [pip]: https://pypi.org/project/pip/
+[ot_python_docs]: https://opentelemetry.io/docs/instrumentation/python/
 [ot_sdk_python]: https://github.com/open-telemetry/opentelemetry-python
 [opentelemetry_instrumentation_requests]: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-requests
 [opentelemetry_instrumentation_flask]: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-flask