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

openbsd: add directory; openbsd/pkg_{add,info,delete}: add page #10698

Merged
merged 4 commits into from Oct 21, 2023

Conversation

mrusme
Copy link
Contributor

@mrusme mrusme commented Sep 8, 2023

  • 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):

As mentioned here I'm creating what seem to be the first few tldrs for OpenBSD, that include pkg_add, pkg_info and pkg_delete.

Closes #816

@CLAassistant
Copy link

CLAassistant commented Sep 8, 2023

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 Sep 8, 2023
@tldr-bot
Copy link

tldr-bot commented Sep 8, 2023

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

pages/openbsd/pkg_add.md:18: TLDR008 File should contain no trailing whitespace
pages/openbsd/pkg_delete.md:18: TLDR008 File should contain no trailing whitespace
pages/openbsd/pkg_info.md:14: TLDR008 File should contain no trailing whitespace

Please fix the error(s) and push again.

@acuteenvy acuteenvy changed the title openbsd: pkg_add, pkg_info, pkg_delete pkg_{add,info,delete}: add page Sep 9, 2023
@kbdharun kbdharun added the architecture Organization of the pages per language, platform, etc. label Sep 26, 2023
@kbdharun kbdharun changed the title pkg_{add,info,delete}: add page openbsd/pkg_{add,info,delete}: add page Sep 26, 2023
@kbdharun kbdharun changed the title openbsd/pkg_{add,info,delete}: add page openbsd: add directory; openbsd/pkg_{add,info,delete}: add page Sep 26, 2023
Copy link
Member

@kbdharun kbdharun left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution, I have started a discussion in our chatroom regarding the new directory addition, let's hope we reach a consensus on it soon.

I have a few suggestions now. I will add a general pkg page which refers to these subpages.

pages/openbsd/pkg_add.md Outdated Show resolved Hide resolved
pages/openbsd/pkg_add.md Outdated Show resolved Hide resolved
pages/openbsd/pkg_add.md Outdated Show resolved Hide resolved
pages/openbsd/pkg_delete.md Outdated Show resolved Hide resolved
pages/openbsd/pkg_delete.md Outdated Show resolved Hide resolved
pages/openbsd/pkg_info.md Outdated Show resolved Hide resolved
pages/openbsd/pkg_info.md Outdated Show resolved Hide resolved
@kbdharun kbdharun requested a review from gutjuri October 21, 2023 16:25
@kbdharun
Copy link
Member

kbdharun commented Oct 21, 2023

Hi, I have taken over this PR and performed the changes as specified in the maintainer's guide; Thanks for your initial work.

For those who haven't checked the chatroom, other maintainers approved having a new openbsd directory for its unique platform-specific commands and packages. So there aren't any blockers in this PR anymore and it can be merged after reviewing the page's contents.

Post this PRs merge, I will update the Client specification to add support for this directory.

pages/openbsd/pkg_delete.md Outdated Show resolved Hide resolved
pages/openbsd/pkg_info.md Outdated Show resolved Hide resolved
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
@kbdharun kbdharun merged commit 2fee1dc into tldr-pages:main Oct 21, 2023
4 checks passed
@kbdharun
Copy link
Member

Just now went through the client specification, I don't think we need to add any additional information about the change as https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#platform and https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#directory-structure are already written in a generalized manner.

@acuteenvy
Copy link
Member

Clients still have to be updated though.

@kbdharun
Copy link
Member

kbdharun commented Oct 21, 2023

Clients still have to be updated though.

Yeah. In the next client specification release, we can mention the new platform addition in the meanwhile we can focus on documenting its pages (maybe with a Let's document issue). Btw, what do you think we should version the next release of client specification? (the last one was 2.0 since it introduced a major change).

I will create a milestone and add your PR and this one to it.

@kbdharun kbdharun modified the milestone: 2.0 Oct 21, 2023
@acuteenvy
Copy link
Member

acuteenvy commented Oct 21, 2023

There's an ongoing client spec PR (#10730) so maybe we can add it there (and bump the version too).

Also, if we are going to add all the BSD platforms, it would be great to add all of them (freebsd, netbsd, etc.) in one PR so as not to change the spec every other day.

@kbdharun
Copy link
Member

There's an ongoing client spec PR (#10730) so maybe we can add it there (and bump the version too).

Yep that's exactly what I am inquiring about, what version number should we choose for the future release so that we can create a milestone (here on this repo) to track all things related to it before creating a release.

@kbdharun
Copy link
Member

Also, if we are going to add all the BSD platforms, it would be great to add all of them (freebsd, netbsd, etc.) in one PR so as not to change the spec every other day.

I think we are only going to add openbsd/freebsd pages to the new directory. Kinda curious, does netbsd have a lot of unique commands?

@acuteenvy
Copy link
Member

what version number should we choose for the future release

Do we consider the placeholder escaping syntax a breaking change? If so, I guess it should be 3.0. Otherwise 2.1.

does netbsd have a lot of unique commands?

A package manager, that's for sure. There's even an issue to document it. Other than that, I don't know, I've never used NetBSD.

@kbdharun
Copy link
Member

Do we consider the placeholder escaping syntax a breaking change? If so, I guess it should be 3.0. Otherwise 2.1.

IMO it isn't a breaking change so we can go with a minor version v2.1. Will create the version now and tag both the PRs.

A package manager, that's for sure. There's even an #7077 to document it. Other than that, I don't know, I've never used NetBSD.

We could document it if there are multiple commands, if not then we can include them under openbsd itself but mention it is for NetBSD.

@kbdharun kbdharun added this to the v2.1 milestone Oct 21, 2023
@kbdharun kbdharun mentioned this pull request Oct 23, 2023
70 tasks
@mrusme mrusme deleted the openbsd branch October 24, 2023 01:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
architecture Organization of the pages per language, platform, etc. new command Issues requesting creation of a new page.
Projects
Development

Successfully merging this pull request may close these issues.

FreeBSD / OpenBSD section(s) proposal.
6 participants