docs: update "features and limitations" regarding BM and TDX #926
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
|
Freax13
reviewed
Oct 11, 2024
docs/docs/features-limitations.md
Outdated
| @@ -5,7 +5,7 @@ This section lists planned features and current limitations of Contrast. | |||
| ## Availability | |||
|
|
|||
| - **Platform support**: At present, Contrast is exclusively available on Azure AKS, supported by the [Confidential Container preview for AKS](https://learn.microsoft.com/en-us/azure/confidential-computing/confidential-containers-on-aks-preview). Expansion to other cloud platforms is planned, pending the availability of necessary infrastructure enhancements. | |||
| - **Bare metal support**: Support for running Contrast on bare metal Kubernetes will be available soon for AMD SEV and Intel TDX. | |||
| - **Bare-metal support**: Support for running [Contrast on bare-metal Kubernetes](getting-started/bare-metal.md) is available for AMD SEV and Intel TDX. | |||
There was a problem hiding this comment.
We use "bare metal" (with a space) in most (all?) other places. We should be consistent about this.
There was a problem hiding this comment.
In this sentence, bare metal is a compound modifier, and those are usually hyphenated if they appear before a noun. (E.g., "The machines are bare metal." vs "It runs on bare-metal machines.")
There was a problem hiding this comment.
That makes sense, thanks for elaborating. Could you apply the same change in other relevant places?
docs/docs/features-limitations.md
Outdated
| @@ -5,7 +5,7 @@ This section lists planned features and current limitations of Contrast. | |||
| ## Availability | |||
|
|
|||
| - **Platform support**: At present, Contrast is exclusively available on Azure AKS, supported by the [Confidential Container preview for AKS](https://learn.microsoft.com/en-us/azure/confidential-computing/confidential-containers-on-aks-preview). Expansion to other cloud platforms is planned, pending the availability of necessary infrastructure enhancements. | |||
| - **Bare metal support**: Support for running Contrast on bare metal Kubernetes will be available soon for AMD SEV and Intel TDX. | |||
| - **Bare-metal support**: Support for running [Contrast on bare-metal Kubernetes](getting-started/bare-metal.md) is available for AMD SEV and Intel TDX. | |||
There was a problem hiding this comment.
Suggested change
| - **Bare-metal support**: Support for running [Contrast on bare-metal Kubernetes](getting-started/bare-metal.md) is available for AMD SEV and Intel TDX. | |
| - **Bare-metal support**: Support for running [Contrast on bare-metal Kubernetes](getting-started/bare-metal.md) is available for AMD SEV-SNP and Intel TDX. |
Technically unrelated to this PR, but we might as well fix this while we're touching this file.
|
CI's not happy yet. |
Freax13
approved these changes
Oct 12, 2024
thomasten
force-pushed
the
t/docs-features-limits
branch
from
51456a9
to
5a3cad7
Compare
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.
No description provided.