Update README to avoid duplicative documentation of setup #214
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #214 +/- ##
=====================================
Coverage 7.04% 7.04%
=====================================
Files 49 49
Lines 1818 1818
Branches 99 99
=====================================
Hits 128 128
Misses 1685 1685
Partials 5 5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
|
Great job, no security vulnerabilities found in this Pull Request |
| @@ -4,215 +4,11 @@ The Bitwarden Key Connector is a self-hosted web application that stores and pro | |||
| clients. | |||
|
|
|||
| The Key Connector project is written in C# using .NET Core with ASP.NET Core. The codebase can be developed, built, run, | |||
| and deployed cross-platform on Windows, macOS, and Linux distributions. | |||
There was a problem hiding this comment.
Question: Is this correct? We include "developed, built, run, and deployed" in one sentence here. As far as I understand, the former 3 are (still) supported on mac. Only deployment is Windows and Linux only. Can we split this into two sentences, than accurately describe the supported scenarios?
"The codebase can be developed, built and run on Windows, macOS and Linux. Production deployment is supported for Windows and Linux."
🎟️ Tracking
https://bitwarden.atlassian.net/browse/PM-22246
📔 Objective
Removed the configuration instructions from the
READMEso that they don't diverge from those in the Help Center, and instead reference the Help Center directly. We had a customer who attempted to use the instructions in theREADME, and their resulting configuration identified that the instructions had diverged.Integrations would prefer that the Help Center be the source of truth in deployment instructions, given that the instructions are targeted at enterprises whose point of contact for Bitwarden documentation is the Help Center.
⏰ Reminders before review
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes