Skip to content
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

fix: update README.md #439

Merged
merged 1 commit into from
Jan 3, 2023
Merged

Conversation

sophware
Copy link
Contributor

@sophware sophware commented Dec 31, 2022

Summary of Pull Request

Updates the README.md to demonstrate the use of 521 bits with ssh-keygen. Valid lengths are 256, 384, or 521.

Type of Pull Request

  • This is a bugfix. type/bug
  • This is an enhancement or feature. type/feature or type/enhancement
  • This is a documentation update. type/docs
  • This is a refactoring update. type/refactor
  • This is a chore. type/chore
  • This is something else.
    Please describe:

Related to Existing Issues

Closes #442

Test and Documentation Coverage

  • Tests have been completed.
  • Documentation has been added or updated.

Breaking Changes?

  • Yes, there are breaking changes.
  • No, there are no breaking changes.

Change key length argument from 512 to 521. Valid lengths are 256, 384 or 521 bits.
@sophware sophware requested a review from a team as a code owner December 31, 2022 05:16
@tenthirtyam
Copy link
Contributor

tenthirtyam commented Jan 1, 2023

Thank you for your contribution, @sophware.

Could we ask that you please update the pull request title and the commit details to follow the conventional commits structure as well as complete the pull request details and an accompanying linked docs issue per the CONTRIBUTING.md.

Here is an example for an update to the README.md: a4935c4

@tenthirtyam tenthirtyam added this to the .Next milestone Jan 1, 2023
@tenthirtyam tenthirtyam added type/docs Documentation status/awaitng-response Awaiting Response labels Jan 1, 2023
@tenthirtyam tenthirtyam changed the title Update README.md fix: update README.md Jan 3, 2023
@tenthirtyam tenthirtyam removed the status/awaitng-response Awaiting Response label Jan 3, 2023
Copy link
Contributor

@tenthirtyam tenthirtyam left a comment

Choose a reason for hiding this comment

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

I've addressed creating and linking a documentation issue as per the contribution guidelines and have updated the pul request title.

@tenthirtyam tenthirtyam merged commit 7ac8a41 into vmware-samples:main Jan 3, 2023
@sophware sophware deleted the readme-patch branch January 3, 2023 16:02
@github-actions
Copy link

github-actions bot commented Feb 3, 2023

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type/docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the key length in the public key creation example
2 participants