-
Notifications
You must be signed in to change notification settings - Fork 76
Adding a new term: key pair #555
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
Adding a new term: key pair #555
Conversation
IngridT1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This addition to the style guide looks good to me. Please make this small change.
|
|
||
| [[<key-pair]] | ||
| ==== image:images/yes.png[yes] key pair (noun) | ||
| *Description*: A _key pair_ is two mathematically linked cryptographic keys: a public key that can be shared and a private key that must be kept secret. The public key encrypts data or verifies signatures, and the private key decrypts data or creates signatures. This pairing is the basis of public-key cryptography used in systems like SSH and TLS/SSL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"is" is not the correct verb here because the predicate is plural, even though the subject is singular. How about this instead?
| *Description*: A _key pair_ is two mathematically linked cryptographic keys: a public key that can be shared and a private key that must be kept secret. The public key encrypts data or verifies signatures, and the private key decrypts data or creates signatures. This pairing is the basis of public-key cryptography used in systems like SSH and TLS/SSL. | |
| *Description*: A _key pair_ is a set of two mathematically linked cryptographic keys: a public key that can be shared and a private key that must be kept secret. The public key encrypts data or verifies signatures, and the private key decrypts data or creates signatures. This pairing is the basis of public-key cryptography used in systems like SSH and TLS/SSL. |
|
|
||
| *See also*: | ||
|
|
||
| [[<key-pair]] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This entry is not building correctly. Perhaps you need to remove the triangular bracket < ?
| [[<key-pair]] | |
| [[key-pair]] |
|
thank you so much, @IngridT1! i'll make the change now. |
1e4cc3b to
064d271
Compare
Preview BuildA preview of this PR has been built and deployed. Preview URL: https://redhat-documentation.github.io/supplementary-style-guide/pr-555/main.html This preview will be updated automatically when new commits are pushed to this PR. This comment is automatically generated by the PR Preview workflow. |
|
changes made, @IngridT1! |
IngridT1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Adding a new term: key pair. I've had to use it more than once and I've seen it spelled as two words and one and I can never remember which is correct. Not addressed in IBMSG.
No need to add if folks think it's unnecessary.