doc: Add a deployment guide covering Helm, containers and the PYPI - #270
Open
641e16 wants to merge 1 commit into
Open
doc: Add a deployment guide covering Helm, containers and the PYPI#270641e16 wants to merge 1 commit into
641e16 wants to merge 1 commit into
Conversation
…package. * docs/deployment.md: Add a guide for the three supported deployment methods, the prerequisites they share, the extra checks production mode enforces, and how to upgrade each one. * mkdocs.yml: Add the deployment guide to the navigation. * docs/index.md: Add the deployment guide to the documentation list. * docs/introduction.md: Correct the Python requirement to 3.10, drop boto3 from the optional packages because it is a regular dependency, trim the remaining optional packages to a pointer, and replace the outdated container image table, which listed a devel tag that does not exist in GHCR, with a reference to the deployment guide. * README.md: Replace the "Running in production" steps with a pointer to the deployment guide, removing instructions that led with the deprecated XML configuration format.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #270 +/- ##
=======================================
Coverage 18.06% 18.06%
=======================================
Files 21 21
Lines 10507 10507
Branches 2038 2038
=======================================
Hits 1898 1898
Misses 8417 8417
Partials 192 192 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
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.
Summary
Adds a deployment guide for djehuty. Removes duplicate text elsewhere.
Changes
Approval Checklist
Issue Reference
Closes #233