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

Documentation Updates #1317

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open

Documentation Updates #1317

wants to merge 21 commits into from

Conversation

TimPansino
Copy link
Contributor

@TimPansino TimPansino commented Mar 3, 2025

Overview

  • Update docs to conform more closely with repo template.
  • Swap all RST files to Markdown for easier compatibility.
    • Converted using Pandoc, then edited.
    • Drop unused RST linters.
  • Removed dead ROADMAP.md file.
  • Removed dead links, and replaced with live ones.
    • learn.newrelic.com is currently rejecting curl requests, and is falsely showing as dead. It's definitely still reachable when visited in a browser.

@TimPansino TimPansino requested a review from a team as a code owner March 3, 2025 21:06
Copy link

github-actions bot commented Mar 3, 2025

🦙 MegaLinter status: ❌ ERROR

Descriptor Linter Files Fixed Errors Elapsed time
✅ MARKDOWN markdownlint 7 0 0 0.81s
❌ MARKDOWN markdown-link-check 7 2 13.36s
❌ PYTHON ruff yes yes 1 0.2s
✅ YAML prettier 10 1 0 0.87s
✅ YAML v8r 10 0 4.44s
✅ YAML yamllint 10 0 0.52s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@codecov-commenter
Copy link

codecov-commenter commented Mar 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.33%. Comparing base (eb8d44b) to head (c409949).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1317   +/-   ##
=======================================
  Coverage   81.33%   81.33%           
=======================================
  Files         203      203           
  Lines       22641    22641           
  Branches     3574     3574           
=======================================
  Hits        18416    18416           
- Misses       3032     3034    +2     
+ Partials     1193     1191    -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mergify mergify bot removed the tests-failing label Mar 4, 2025
@mergify mergify bot added the tests-failing label Mar 6, 2025
@mergify mergify bot removed the tests-failing label Mar 7, 2025
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.

2 participants