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

Let's document: cups #6597

Closed
20 tasks done
pixelcmtd opened this issue Sep 24, 2021 · 9 comments · Fixed by #6623, #11745, #11843, #11898 or #12166
Closed
20 tasks done

Let's document: cups #6597

pixelcmtd opened this issue Sep 24, 2021 · 9 comments · Fixed by #6623, #11745, #11843, #11898 or #12166
Labels
good first issue Recommended issues for first-time contributors help wanted You can help make tldr-pages better! let's document Tracker issue to document multiple subcommands/commands of a tool or utility or category. new command Issues requesting creation of a new page.

Comments

@pixelcmtd
Copy link
Member

pixelcmtd commented Sep 24, 2021

This list is not complete at all. Look at the official documentation for more. The list contains all CUPS commands

@pixelcmtd pixelcmtd added new command Issues requesting creation of a new page. help wanted You can help make tldr-pages better! labels Sep 24, 2021
@marchersimon marchersimon changed the title page request: cups Let's document: cups Sep 24, 2021
@marchersimon
Copy link
Collaborator

We usually use page request only for single or a few unrelated pages.

@reinhart1010
Copy link
Collaborator

I might want to do cups-config and
cupsd

@reinhart1010
Copy link
Collaborator

@pixelcmtd You might want to update the list

@navarroaxel navarroaxel reopened this Oct 24, 2021
@reinhart1010
Copy link
Collaborator

I might want to write for cupsctl as well, but I'm still not sure how to summarize parameters like:

--[no-]remote-admin
    Enables (disables) remote administration. 

in a way that complies with our current style guide.

@marchersimon
Copy link
Collaborator

If there's enough space left in the page, I'd go with this:

- Enable remote administration:

`cupsctl --remote-admin`

- Disable remote administration:

`cupsctl --no-remote-admin`

But if not you could combine it:

- Enable or disable remote administration:

`cupsctl --remote-admin|--no-remote-admin`

But I'm not actually sure if documenting both is even necessary. On of those has to be the default, right? We should we document it if it doesn't change anything?

@kbdharun kbdharun added the good first issue Recommended issues for first-time contributors label Oct 22, 2022
@kbdharun kbdharun added the let's document Tracker issue to document multiple subcommands/commands of a tool or utility or category. label Oct 21, 2023
@kbdharun kbdharun reopened this Dec 17, 2023
@vitorhcl
Copy link
Member

vitorhcl commented Dec 26, 2023

@kbdharun @sebastiaanspeck cupsfilter and some more commands that I haven't added to the list are deprecated. We don't need to document these commands, right?

@sebastiaanspeck
Copy link
Member

sebastiaanspeck commented Dec 26, 2023

@kbdharun @sebastiaanspeck cupsfilter and some more commands that I haven't added to the list are deprecated. We don't need to document these commands, right?

AFAIK we generally don't add deprecated commands. Or do we add and document them as deprecated?

@kbdharun
Copy link
Member

Nice catch @sebastiaanspeck (thanks for reopening).

@vitorhcl minor suggestion in PR/commit descriptions it is suggested to use terms like "For #issue" or some other wording instead of " closes #issue", " fixes #issue" and " completes #issue" when there are remaining commands not having a page yet as GitHub detects these words automatically and closes the issue when your PR/commit is merged.

@vitorhcl
Copy link
Member

Nice catch @sebastiaanspeck (thanks for reopening).

@vitorhcl minor suggestion in PR/commit descriptions it is suggested to use terms like "For #issue" or some other wording instead of " closes #issue", " fixes #issue" and " completes #issue" when there are remaining commands not having a page yet as GitHub detects these words automatically and closes the issue when your PR/commit is merged.

Oooh, got it, thanks for the tip.

@vitorhcl vitorhcl mentioned this issue Jan 8, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Recommended issues for first-time contributors help wanted You can help make tldr-pages better! let's document Tracker issue to document multiple subcommands/commands of a tool or utility or category. new command Issues requesting creation of a new page.
Projects
None yet
7 participants