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.

Sign up for GitHub

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

Jump to bottom

doc: Fix SSH key example in README; swap _ with - in pip install command #40

Merged
merged 1 commit into from
Apr 9, 2024
Merged

doc: Fix SSH key example in README; swap _ with - in pip install command #40

merged 1 commit into from
Apr 9, 2024

Conversation

lgarber-akamai
Copy link
Contributor

📝 Description

This change corrects the following documentation errors:

  • The SSH key example in the README referenced the root user using the old-style reference format, which has since been replaced with a dict
  • The pip install examples have been swapped from linode_metadata to linode-metadata
    • Pip automatically replaces _'s with -'s, but we can reduce user confusion by ensuring the install command lines up with what is shown on PyPI

✔️ How to Test

N/A

@lgarber-akamai lgarber-akamai requested a review from a team as a code owner April 8, 2024 17:33
@lgarber-akamai lgarber-akamai requested review from jriddle-linode and yec-akamai and removed request for a team April 8, 2024 17:33
@lgarber-akamai lgarber-akamai added the documentation for updates to the documentation in the changelog. label Apr 8, 2024
zliang-akamai
zliang-akamai approved these changes Apr 8, 2024
View reviewed changes
Copy link
Member

@zliang-akamai zliang-akamai left a comment

Choose a reason for hiding this comment

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

LGTM!

yec-akamai
yec-akamai approved these changes Apr 9, 2024
View reviewed changes
Copy link
Contributor

@yec-akamai yec-akamai left a comment

Choose a reason for hiding this comment

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

Nice catching the docs gap!

@lgarber-akamai lgarber-akamai merged commit 7f109d3 into linode:main Apr 9, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yec-akamai yec-akamai yec-akamai approved these changes

@zliang-akamai zliang-akamai zliang-akamai approved these changes

@jriddle-linode jriddle-linode Awaiting requested review from jriddle-linode jriddle-linode is a code owner automatically assigned from linode/dx

Assignees
No one assigned
Labels
documentation for updates to the documentation in the changelog.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lgarber-akamai @zliang-akamai @yec-akamai