Skip to content

Conversation

@jseseCCS
Copy link
Contributor

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.

Copy link
Collaborator

@IngridT1 IngridT1 left a 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.
Copy link
Collaborator

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?

Suggested change
*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]]
Copy link
Collaborator

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 < ?

Suggested change
[[<key-pair]]
[[key-pair]]

@jseseCCS
Copy link
Contributor Author

thank you so much, @IngridT1! i'll make the change now.

@jseseCCS jseseCCS force-pushed the jsese/add-new-term-key-pair branch from 1e4cc3b to 064d271 Compare November 25, 2025 13:08
@github-actions
Copy link
Contributor

Preview Build

A 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.

@jseseCCS
Copy link
Contributor Author

changes made, @IngridT1!

Copy link
Collaborator

@IngridT1 IngridT1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@IngridT1 IngridT1 merged commit 047c2ca into redhat-documentation:main Nov 25, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants