Skip to content

docs: update README and migration guide to reflect current capabilities - #52

Merged
Hector Hernandez (hectorhdzg) merged 6 commits into
microsoft:mainfrom
hectorhdzg:docs/update-readme-and-migration-guide
Apr 22, 2026
Merged

Hector Hernandez (hectorhdzg) merged 6 commits into
microsoft:mainfrom
hectorhdzg:docs/update-readme-and-migration-guide

Conversation

@hectorhdzg

Copy link
Copy Markdown
Member
  • Add license and Python version badges to README
  • Add Getting Started section with prerequisites and install instructions
  • Add OTLP export configuration section with all supported env vars
  • Add auto-instrumented libraries table (web, HTTP, GenAI, Azure SDK)
  • Document FIC authentication environment variables for A365
  • Add Troubleshooting, Next Steps sections matching Azure Monitor repo style
  • Add CLA and Code of Conduct to Contributing section
  • Replace stale Planned Scope with implemented Features section
  • Add ENABLE_OBSERVABILITY to migration env var mapping table

- Add license and Python version badges to README
- Add Getting Started section with prerequisites and install instructions
- Add OTLP export configuration section with all supported env vars
- Add auto-instrumented libraries table (web, HTTP, GenAI, Azure SDK)
- Document FIC authentication environment variables for A365
- Add Troubleshooting, Next Steps sections matching Azure Monitor repo style
- Add CLA and Code of Conduct to Contributing section
- Replace stale Planned Scope with implemented Features section
- Add ENABLE_OBSERVABILITY to migration env var mapping table

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository documentation to reflect current microsoft-opentelemetry distro capabilities and configuration surface, aligning README content with Azure Monitor/OTLP/A365 onboarding expectations.

Changes:

  • Refresh README with badges, Getting Started instructions, expanded configuration sections (OTLP, auto-instrumentation, FIC auth), and troubleshooting/next steps.
  • Update A365 migration guide env var mapping to include ENABLE_OBSERVABILITY.
  • Modernize contributing section content to include CLA and Code of Conduct references.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/MIGRATION_A365.md Adds ENABLE_OBSERVABILITY to the migration env var mapping table for A365 scope span emission.
README.md Replaces placeholder/stale sections with current onboarding, configuration, and capability documentation (OTLP, auto-instrumentation, A365/FIC, troubleshooting).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
@hectorhdzg
Hector Hernandez (hectorhdzg) merged commit f1c0f8c into microsoft:main Apr 22, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants