Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(otel): sort OTel components #6616

Merged
merged 2 commits into from
Jan 29, 2025

Conversation

andrzej-stencel
Copy link
Contributor

What does this PR do?

Modifies the mage otel:readme command to sort the OTel components by name in the OTel README.

Why is it important?

It is much easier to find the component you're looking for in the list of supported EDOT Collector components when they are sorted by name.

Checklist

  • I have read and understood the pull request guidelines of this project.
  • My code follows the style guidelines of this project
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • [ ] I have made corresponding change to the default configuration files
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] I have added an entry in ./changelog/fragments using the changelog tool
  • [ ] I have added an integration test or an E2E test

Modifies the `mage otel:readme` command to sort the OTel components by name in the OTel README.
@andrzej-stencel andrzej-stencel added Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team docs skip-changelog backport-8.x Automated backport to the 8.x branch with mergify backport-8.17 Automated backport with mergify labels Jan 28, 2025
@andrzej-stencel andrzej-stencel requested a review from a team as a code owner January 28, 2025 09:57
@elasticmachine
Copy link
Contributor

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@andrzej-stencel andrzej-stencel merged commit 0d5a1ad into elastic:main Jan 29, 2025
14 checks passed
mergify bot pushed a commit that referenced this pull request Jan 29, 2025
* docs(otel): sort OTel components

Modifies the `mage otel:readme` command to sort the OTel components by name in the OTel README.

* refactor: sort complete lists instead of while inserting

(cherry picked from commit 0d5a1ad)

# Conflicts:
#	internal/pkg/otel/README.md
mergify bot pushed a commit that referenced this pull request Jan 29, 2025
* docs(otel): sort OTel components

Modifies the `mage otel:readme` command to sort the OTel components by name in the OTel README.

* refactor: sort complete lists instead of while inserting

(cherry picked from commit 0d5a1ad)

# Conflicts:
#	internal/pkg/otel/README.md
andrzej-stencel added a commit that referenced this pull request Jan 29, 2025
* docs(otel): sort OTel components (#6616)

* docs(otel): sort OTel components

Modifies the `mage otel:readme` command to sort the OTel components by name in the OTel README.

* refactor: sort complete lists instead of while inserting

(cherry picked from commit 0d5a1ad)

# Conflicts:
#	internal/pkg/otel/README.md

* mage otel:readme

---------

Co-authored-by: Andrzej Stencel <[email protected]>
andrzej-stencel added a commit that referenced this pull request Jan 30, 2025
* docs(otel): sort OTel components (#6616)

* docs(otel): sort OTel components

Modifies the `mage otel:readme` command to sort the OTel components by name in the OTel README.

* refactor: sort complete lists instead of while inserting

(cherry picked from commit 0d5a1ad)

# Conflicts:
#	internal/pkg/otel/README.md

* mage otel:readme

---------

Co-authored-by: Andrzej Stencel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.17 Automated backport with mergify docs skip-changelog Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants