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

ntpd: add page #12682

Merged
merged 5 commits into from Apr 28, 2024
Merged

ntpd: add page #12682

merged 5 commits into from Apr 28, 2024

Conversation

ewen-lbh
Copy link
Contributor

  • 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 PR title conforms to the recommended templates.
  • Version of the command being documented (if known): 4.2.8

@ewen-lbh ewen-lbh requested a review from cyqsimon as a code owner April 26, 2024 18:11
@CLAassistant
Copy link

CLAassistant commented Apr 26, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Apr 26, 2024
@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

@tldr-bot

This comment was marked as outdated.

Copy link
Member

@vitorhcl vitorhcl left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution! This command was missing indeed and you brought a good and simple example usage :)

I have some suggestions about the guidelines we generally follow. See details in https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md.

pages/linux/ntpd.md Outdated Show resolved Hide resolved
pages/linux/ntpd.md Show resolved Hide resolved
pages/linux/ntpd.md Outdated Show resolved Hide resolved
@vitorhcl
Copy link
Member

I think https://manned.org/ntpd is more adequate for the "More information" link, because the linux version has some differences. For example, you used long options that are not on https://www.ntp.org/documentation/4.2.8-series/ntpd/.

@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/linux/ntpd.md:9 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Synchronize system time with..."]
pages/linux/ntpd.md:9: TLDR007 Example descriptions should be surrounded by empty lines

Please fix the error(s) and push again.

@ewen-lbh
Copy link
Contributor Author

I think https://manned.org/ntpd is more adequate for the "More information" link, because the linux version has some differences. For example, you used long options that are not on https://www.ntp.org/documentation/4.2.8-series/ntpd/.

Yeah, I hesitated on that but wanted to get to the "root source" of information, but I guess that if the tldr page has linux-specific options, the manned page is better

@tldr-bot

This comment has been minimized.

@vitorhcl
Copy link
Member

Yeah, I hesitated on that but wanted to get to the "root source" of information, but I guess that if the tldr page has linux-specific options, the manned page is better

The previous URL pointed to the specification, while the current URL points to the implementation documentation, so it is more accurate about the command usage.

Copy link
Member

@vitorhcl vitorhcl left a comment

Choose a reason for hiding this comment

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

LGTM!

Thank you for your your quick fixes and, again, for your contribution :)

Welcome to tldr! Feel free to contribute to the project in any way you want.

@sebastiaanspeck sebastiaanspeck merged commit 95cc093 into tldr-pages:main Apr 28, 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.

None yet

6 participants