DOC: Moved the ChatOps deployment steps and requirements to an INSTALL.md file #62
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also removed "-d" from docker run command to build and run locally
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #62 +/- ##
=======================================
Coverage 98.68% 98.68%
=======================================
Files 12 12
Lines 608 608
=======================================
Hits 600 600
Misses 8 8 ☔ View full report in Codecov by Sentry. |
meoflynn
previously approved these changes
Nov 5, 2024
khalford
requested changes
Nov 5, 2024
khalford
approved these changes
Nov 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main changes made were:
The deployment instructions and requirements were moved from README.md to INSTALL.md
A few fixes were made for the local run instructions using docker.
A small
Dependenciessection was also added withinDeploymentto make sure users know of Python 3.10+ requirements (if running from source) and docker user group addition (if running via docker)