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

freebsd, netbsd: add directory; pkg, pkgin: add page #11313

Merged
merged 4 commits into from
Oct 29, 2023

Conversation

acuteenvy
Copy link
Member

  • 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.

This PR adds the freebsd and netbsd directories and pages for their package managers.

We definitely don't want to add a big amount of platform directories. I'd like to hear everyone's opinion on adding more BSDs. I think those are the three most popular ones (+OpenBSD), and I wouldn't add any more myself after this.
Each platform addition requires updating all the clients, so adding them all in one go would be ideal.

Discussed in #10698.
Closes #7077.

@acuteenvy acuteenvy added architecture Organization of the pages per language, platform, etc. decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. labels Oct 27, 2023
@github-actions github-actions bot added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Oct 27, 2023
Copy link
Member

@Magrid0 Magrid0 left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks for your contribution!

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.

The directory changes LGTM. Thanks.

Nitpick: I would suggest moving the install and remove examples to the top of the pages.


Excerpts from the chatroom (OpenBSD addition discussion)

Myself

Someone seems to have opened a PR to add pages for openbsd in a new directory #10698, which is suggested in #816. What do you guys think, can we go ahead with the addition of new directory.

By @pixelcmtd

Yea I wasn't sure about possibly adding so many new platforms (openbsd, freebsd, netbsd, ...), as having one bsd platform would be so nice, but also probably impossible, because, as some have already pointed out, the BSD-derivates are very different in some aspects (a good example of this actually is mktemp). So it just went on my mental list of things to reply to "later". I think adding an openbsd platform here (i.e. merging the PR, assuming the pages are good) is probably the right judgement


It is indeed better to have BSD platforms added in a single go than adding them later for updating the clients + These projects pass the notability criteria to be added to tldr.

pages/freebsd/pkg.md Outdated Show resolved Hide resolved
@kbdharun kbdharun added the hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. label Oct 28, 2023
@acuteenvy acuteenvy requested a review from kbdharun October 28, 2023 12:11
@pixelcmtd
Copy link
Member

Each platform addition requires updating all the clients

I've read pretty much this exact take from multiple people in the discussions around BSD platforms and I'm not sure I understand what you're referring to. Shouldn't a well-written client be able to display any page from any platform, as long as it exists? I'm aware of the fact that some clients (I checked a few, apparently most clients) might choose to make platforms, for example, an enum type and thereby check it's a platform the client knows about. But I don't think that's the right solution, at least in most cases. In my opinion, clients should be able to look at the pages directory to find all platforms that actually exist. (and we could possibly suggest that in the client spec)

@kbdharun
Copy link
Member

kbdharun commented Oct 28, 2023

I've read pretty much this exact take from multiple people in the discussions around BSD platforms and I'm not sure I understand what you're referring to. Shouldn't a well-written client be able to display any page from any platform, as long as it exists? I'm aware of the fact that some clients (I checked a few, apparently most clients) might choose to make platforms, for example, an enum type and thereby check it's a platform the client knows about. But I don't think that's the right solution, at least in most cases. In my opinion, clients should be able to look at the pages directory to find all platforms that actually exist. (and we could possibly suggest that in the client spec)

Agreed, this is something that we should define with a suggested clause in the client specification (will add it to the tracker issue). However, it would probably be difficult to implement in a majority of the community clients as they are all different implementations in various programming languages. In the case of the official clients, a few ones like the web client from the in-browser app, Node client does require manually updating the platforms for various reasons like Unit tests (in Node client which we specify a template page), etc.

Edit. Updated the tracker issue.

@kbdharun kbdharun mentioned this pull request Oct 28, 2023
70 tasks
pages/netbsd/pkgin.md Outdated Show resolved Hide resolved
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
@kbdharun kbdharun merged commit 28a74a9 into tldr-pages:main Oct 29, 2023
3 checks passed
@acuteenvy acuteenvy deleted the bsds branch October 29, 2023 13:11
@kbdharun kbdharun added this to the v2.1 milestone Nov 29, 2023
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. decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. new command Issues requesting creation of a new page or PRs adding a new page for a command.
Projects
Development

Successfully merging this pull request may close these issues.

page request: pkgin
5 participants