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

Quality of life improvement for documentation #602

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from

Conversation

tylmorr-snl
Copy link
Collaborator

@tylmorr-snl tylmorr-snl commented Feb 22, 2025

🗣 Description

Improvements made to the LME readme and elastic agent management documentation for clarity and readability.

💭 Motivation and context

Improve readability and clarity of documentation to make installation easier.

🧪 Testing

Performed testing by running through an installation following the enhanced readme.

✅ Pre-approval checklist

  • Changes are limited to a single goal AND
    the title reflects this in a clear human readable format
  • Issue that this PR solves has been selected in the Development section
  • I have read and agree to LME's CONTRIBUTING.md document.
  • The PR adheres to LME's requirements in RELEASES.md
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.

✅ Pre-merge Checklist

  • All tests pass
  • PR has been tested and the documentation for testing is above
  • Squash and merge all commits into one PR level commit

✅ Post-merge Checklist

  • Delete the branch to keep down number of branches

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 Product Backlog
Development

Successfully merging this pull request may close these issues.

2 participants