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

podman-login: add page #14915

Merged
merged 2 commits into from
Nov 21, 2024
Merged

podman-login: add page #14915

merged 2 commits into from
Nov 21, 2024

Conversation

cyqsimon
Copy link
Collaborator

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known): 5.3.0

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Nov 19, 2024
Copy link
Member

@spageektti spageektti left a comment

Choose a reason for hiding this comment

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

Hi. Have you thought about spliting this page into linux and common version to make descriptions more clear?

@cyqsimon
Copy link
Collaborator Author

Hi. Have you thought about spliting this page into linux and common version to make descriptions more clear?

Yeah this thought did go through my head but ultimately I decided against it. These are the main reasons:

  • They are fundamentally the same subcommand within the same binary. Login persistence is the only platform-dependent difference.
  • Having two pages increases maintenance burden, especially if someone adds more examples in the future.
  • Podman is a tool primarily intended to run on Linux (on Windows or macOS it actually proxies most of its actions to a Linux VM). A significant proportion of users will likely be using it on Linux directly after using it for development on their personal non-Linux computers, so it would be wise to inform them of this important difference when they first look it up on their personal computers.

So I'm inclined to keep it as is. Hopefully you understand.

pages/common/podman-login.md Outdated Show resolved Hide resolved
@cyqsimon
Copy link
Collaborator Author

Thanks all; excellent recommendations. Committed.

@spageektti spageektti merged commit da2e0ed into tldr-pages:main Nov 21, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants