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

Let's document: tj/git-extras #5137

Closed
73 tasks done
bl-ue opened this issue Jan 11, 2021 · 24 comments
Closed
73 tasks done

Let's document: tj/git-extras #5137

bl-ue opened this issue Jan 11, 2021 · 24 comments
Labels
good first issue Recommended issues for first-time contributors help wanted You can help make tldr-pages better! new command Issues requesting creation of a new page.

Comments

@bl-ue
Copy link
Contributor

bl-ue commented Jan 11, 2021 •
edited by kbdharun
Loading

We should add the commands from tj/git-extras (73):
@bl-ue bl-ue added new command Issues requesting creation of a new page. help wanted You can help make tldr-pages better! labels Jan 11, 2021
@bl-ue bl-ue mentioned this issue Jan 11, 2021
Open
@sbrl
Copy link
Member

sbrl commented Jan 16, 2021

Is there any overlap with #3953? if so, we should edit #3953 and move the relevant ones over here.

@bl-ue
Copy link
Contributor Author

bl-ue commented Jan 16, 2021 •
edited by waldyrious
Loading

@sbrl no. I had initially added the git-extras commands into #3953, but then per @waldyrious's suggestion, moved them here.

@waldyrious
Copy link
Member

I'm not sure this was made clear before, but might want to come to an agreement about whether to document these as top-level commands (e.g. git-ignore.md) or subcommands of git-extras (e.g. git-extras-ignore.md). I'm concerned that there may be a lot of overlap of command names with similar git CLI helpers (some of which are listed here), and we probably don't want to give priority to one of them, or worse, assign precedence on a first-come-first-served basis.

Pinging @CleanMachine1 as a heads-up, due to this comment on Gitter.

@CleanMachine1
Copy link
Member

well to be honest, I didn't plan to do the ones which overlap, however what could be done, in the git included ones which overlap, maybe put a, see also in the desc

@patricedenis patricedenis linked a pull request May 12, 2021 that will close this issue
git-cp: add page #5947
Merged
6 tasks
@bl-ue bl-ue removed a link to a pull request May 12, 2021
git-cp: add page #5947
Merged
6 tasks
@patricedenis patricedenis linked a pull request May 12, 2021 that will close this issue
git-delete-tag: add page #5948
Merged
6 tasks
@waldyrious
Copy link
Member

To be clear, I meant overlap with other git CLI helpers (which may use the same subcommand names), not just with git itself.

@CleanMachine1
Copy link
Member

OK, what do you suggest?

@bl-ue
Copy link
Contributor Author

bl-ue commented May 12, 2021

I don't think that git-extras-<command>.md is very good because I doubt anyone would every think to try tldr git extras <command>, the reason for that being that git extras and git extras <command> simply show the git-extras man page, and don't actually execute and commands 🤔

@patricedenis
Copy link
Collaborator

patricedenis commented May 12, 2021 •
edited
Loading

yes. I feel the same way.
I think it's better to keep the name of the tldr commands as near as the invocation the users will tape.

@CleanMachine1
Copy link
Member

Since there is no autofill with tldr, I agree that it is better to keep it similar to what the user will type for their actual command.

@marchersimon
Copy link
Collaborator

How does the system prioritize them? When you execute a git subcommand which is also a git-extras subcommand, somehow the shell has to figure out which one to use.

This was referenced May 12, 2021
Merged
Merged
Merged
Merged
@CleanMachine1
Copy link
Member

Why have you closed?

@marchersimon marchersimon reopened this May 13, 2021
@CleanMachine1
Copy link
Member

@marchersimon

@marchersimon
Copy link
Collaborator

@patricedenis linked this issue with #5948 and when I merged it it was closed.

@CleanMachine1
Copy link
Member

Ok, just thought we were going to discontinue support git-extras, I plan on doing more maybe tomorrow

@bl-ue bl-ue removed a link to a pull request May 13, 2021
git-delete-tag: add page #5948
Merged
6 tasks
@bl-ue
Copy link
Contributor Author

bl-ue commented May 13, 2021

Yep, definitely not intended.

@sbrl
Copy link
Member

sbrl commented May 14, 2021

Generally speaking in our case, documenting extra subcommands that are part of an addon is fine (though I recommend mentioning that they are part of an external program or something in the description), but we do not want to overwrite any pre-existing core git commands - those should be prioritised over anything provided by a third party extension.

@bl-ue bl-ue mentioned this issue May 14, 2021
Merged
6 tasks
This was referenced Jun 17, 2021
Merged
Merged
@CleanMachine1 CleanMachine1 mentioned this issue Jul 17, 2021
Merged
6 tasks
This was referenced Sep 30, 2021
Merged
Merged
Merged
This was referenced Oct 31, 2021
Merged
Merged
Merged
Merged
@einverne einverne mentioned this issue Oct 1, 2022
Open
46 tasks
@CleanMachine1 CleanMachine1 added the good first issue Recommended issues for first-time contributors label Oct 3, 2022
This was referenced Oct 4, 2022
Merged
Merged
Merged
@KMohZaid KMohZaid mentioned this issue Oct 15, 2022
Merged
5 tasks
@deadpyxel deadpyxel mentioned this issue Oct 31, 2022
Merged
5 tasks
This was referenced Oct 8, 2023
Merged
Merged
Merged
@sebastiaanspeck
Copy link
Member

rscp is a symlink for scp. Do we add pages for symlinks?

@kbdharun
Copy link
Member

kbdharun commented Oct 15, 2023 •
edited
Loading

rscp is a symlink for scp. Do we add pages for symlinks?

We could add it as an alias page to highlight that this command is an alias of a different page.

@sebastiaanspeck
Copy link
Member

Like this? #10996

@sebastiaanspeck
Copy link
Member

fresh-branch is merged, but not ticked

@kbdharun
Copy link
Member

fresh-branch is merged, but not ticked

On it, will update it for the other open PRs too.

@sebastiaanspeck
Copy link
Member

fresh-branch is merged, but not ticked

On it, will update it for the other open PRs too.

Great! Missed one: #10995

@sebastiaanspeck
Copy link
Member

All open PR's are merged, so we can complete this issue! 🚀

@sebastiaanspeck
Copy link
Member

Maybe unpin this one since it is closed?

@kbdharun kbdharun unpinned this issue Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Recommended issues for first-time contributors help wanted You can help make tldr-pages better! new command Issues requesting creation of a new page.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@waldyrious @patricedenis @sbrl @sebastiaanspeck @kbdharun @marchersimon @bl-ue @CleanMachine1