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

fstab: add page #7883

Closed
wants to merge 5 commits into from
Closed

fstab: add page #7883

wants to merge 5 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Mar 13, 2022

  • The page (if new), does not already exist in the repository.
  • The page is in the correct platform directory (common/, linux/, etc.)
  • The page has 8 or fewer examples.
  • The PR title conforms to the recommended templates.
  • The page follows the content guidelines.
  • The page description includes a link to documentation or a homepage (if applicable).

Version of the command being documented (if known):

This is my first time making a pull request and I don't quite know how it works. Please tell me if I did anything wrong.

@CLAassistant

This comment was marked as outdated.

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Mar 13, 2022
@navarroaxel navarroaxel changed the title Create fstab.md fstab: add page Mar 13, 2022
@tldr-bot

This comment was marked as outdated.

Copy link
Member

@mfrw mfrw left a comment

Choose a reason for hiding this comment

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

Wondering if we should add something that is not a command.
Although, one example cgroups comes to mind.
Thoughts ?

@EmilyGraceSeville7cf
Copy link
Contributor

Wondering if we should add something that is not a command.
Although, one example cgroups comes to mind.
Thoughts ?

It's a good idea. Just instead of code samples any other one-liners will be placed such as configs. The problem arises when tl;dr page describes config that doesn't support joining several lines and mandates \n.

@navarroaxel
Copy link
Member

Wondering if we should add something that is not a command. Although, one example cgroups comes to mind. Thoughts ?

tldr is for command examples, so it could be command related to fstab, example:

`echo '/swapfile none swap defaults 0 0' | tee --append /etc/fstab`

@ghost
Copy link
Author

ghost commented Mar 14, 2022

ill fix the errors soon, i need to study as of right now, thanks everyone for the help so far :)

fixed errors
Copy link
Author

@ghost ghost left a comment

Choose a reason for hiding this comment

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

i hopefully fixed the errors mentioned above. if there are still problems please let me know

@tldr-bot

This comment was marked as outdated.

pages/linux/fstab.md Outdated Show resolved Hide resolved
pages/linux/fstab.md Outdated Show resolved Hide resolved
@github-actions

This comment was marked as outdated.

@github-actions github-actions bot added the waiting Issues/PRs with Pending response by the author. label Apr 4, 2022
@EmilyGraceSeville7cf EmilyGraceSeville7cf removed the waiting Issues/PRs with Pending response by the author. label Apr 4, 2022
@ghost
Copy link
Author

ghost commented Apr 6, 2022

hi, recently ive had some stress with school but i did not forget this pr. thanks for checking in, i'll resolve errors soon

@CleanMachine1 CleanMachine1 added the waiting Issues/PRs with Pending response by the author. label Apr 20, 2022
@github-actions

This comment was marked as outdated.

@github-actions github-actions bot closed this Jun 2, 2022
@github-actions github-actions bot removed the waiting Issues/PRs with Pending response by the author. label Jun 2, 2022
@tldr-bot

This comment was marked as outdated.

Copy link
Contributor

@EmilyGraceSeville7cf EmilyGraceSeville7cf left a comment

Choose a reason for hiding this comment

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

Please fix syntax errors. 😄

pages/linux/fstab.md Outdated Show resolved Hide resolved
@tldr-bot

This comment was marked as outdated.

pages/linux/fstab.md Outdated Show resolved Hide resolved
pages/linux/fstab.md Outdated Show resolved Hide resolved
pages/linux/fstab.md Outdated Show resolved Hide resolved
pages/linux/fstab.md Outdated Show resolved Hide resolved
pages/linux/fstab.md Outdated Show resolved Hide resolved
@tldr-bot

This comment was marked as outdated.

Copy link
Contributor

@EmilyGraceSeville7cf EmilyGraceSeville7cf left a comment

Choose a reason for hiding this comment

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

Remove examples from description: they make it too long.

pages/linux/fstab.md Outdated Show resolved Hide resolved
@EmilyGraceSeville7cf
Copy link
Contributor

Errors are fixed because no author response is obtain for a long time.

@marchersimon
Copy link
Collaborator

I'm really not sure if we should accept this page. We had this situation a few times in the past and always decided that it should be addad to another project like cheat.sh instead.

I know it's often frustrating to have to reject seemingly good ideas, but we just don't have the capabilities to maintain all this. When we accept non-command pages, there would have to be a whole new style guide, probably new syntax, new rules, etc.

(Also, cgroups does fit this project's scope, because it's merely an alias page to a few other commands. A little unusual, but not much.)

@ghost
Copy link
Author

ghost commented Jul 25, 2022

ill be honest, i kinda forgot about this contribution. originally though, i thought of tldr being an 'ez help' kinda program which the name suggests. im not sure if youd have to make a whole new stylesheet guide for 'non command pages' cuz i think no matter what man page, it can be shortened for this project

the decision is up to you after all tho since i didnt really do much except the initial commit

@marchersimon
Copy link
Collaborator

Thanks for understanding. You could try contributing your page to cheat.

Copy link
Member

@navarroaxel navarroaxel left a comment

Choose a reason for hiding this comment

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

I'm really not sure if we should accept this page. We had this situation a few times in the past and always decided that it should be addad to another project like cheat.sh instead.

I think we can accept 1 o 2 examples like the following:

echo '/swapfile none swap defaults 0 0' | tee --append /etc/fstab

but not an explanation about the structure of this file.

@marchersimon
Copy link
Collaborator

@navarroaxel but we can't just throw in '/swapfile none swap defaults 0 0' without explaining its structure. That probably wouldn't be very useful.

@navarroaxel
Copy link
Member

navarroaxel commented Jul 26, 2022

@navarroaxel but we can't just throw in '/swapfile none swap defaults 0 0' without explaining its structure. That probably wouldn't be very useful.

@marchersimon well, in the example description we can explain some params. Anyway this isn't a command, and tldr is for terminal commands.

@sbrl
Copy link
Member

sbrl commented Aug 2, 2022

Sorry, tldr-pages only documents commands, so we can't accept this page. However, there are a number of sister projects like the aforementioned cheat.sh where this would fit better.

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.

9 participants