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

genfstab: add page #5215

Merged
merged 6 commits into from
Feb 3, 2021
Merged

genfstab: add page #5215

merged 6 commits into from
Feb 3, 2021

Conversation

peterbabic
Copy link
Contributor

  • The page (if new), does not already exist in the repo.
  • 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).

@CLAassistant
Copy link

CLAassistant commented Feb 1, 2021

CLA assistant check
All committers have signed the CLA.

@tldr-bot
Copy link

tldr-bot commented Feb 1, 2021

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

Error: Parse error on line 4:
...ripts/genfstab.8.en>- Generate the out
-----------------------^
Expecting 'END_INFORMATION_LINK_URL', got 'NEWLINE'
pages/linux/genfstab.md:4: TLDR011 Page never contains more than a single empty line

Please fix the error(s) and push again.

@tldr-bot
Copy link

tldr-bot commented Feb 1, 2021

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

pages/linux/genfstab.md:6: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/linux/genfstab.md:10: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/linux/genfstab.md:14: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/linux/genfstab.md:18: TLDR005 Example descriptions should end in a colon with no trailing characters

Please fix the error(s) and push again.

Copy link
Contributor Author

@peterbabic peterbabic left a comment

Choose a reason for hiding this comment

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

add maintainer suggestions

EDIT: do not know what to do, still reluctantly learning Github
EDIT2: somehow added maintainer suggestions into "batch" and committed them, hopefully this was expected

Co-authored-by: Axel Navarro <navarroaxel@gmail.com>
Copy link
Contributor

@bl-ue bl-ue left a comment

Choose a reason for hiding this comment

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

Hi @peterbabic, thank you for the new page! I've left some comments below for you to review.

@bl-ue bl-ue added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Feb 1, 2021
@peterbabic
Copy link
Contributor Author

Unfortunately I do not agree wit any of the changes @bl-ue suggested, not meaning to be rude by any way. I have provided explanations to all of them.

@bl-ue
Copy link
Contributor

bl-ue commented Feb 1, 2021

@peterbabic no problem! Sometimes we have difficulty communicating through a purely textual medium :) I've responded to your comments.

Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
@peterbabic
Copy link
Contributor Author

@bl-ue no poblem as well! Thanks for suggestions. Did not know about the nature of "an ef-es-tab file" 😄

@peterbabic peterbabic requested a review from bl-ue February 1, 2021 17:24
Copy link
Contributor

@bl-ue bl-ue left a comment

Choose a reason for hiding this comment

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

Okay, thanks for the help @navarroaxel. @peterbabic I have only two more comments.

@peterbabic
Copy link
Contributor Author

I have added another commit where I believe the changes are the most consistent. I have also removed backticks around fstab as it is word, not a code nor a path.

@peterbabic
Copy link
Contributor Author

Maybe the last thing I would check is if volume is the right word, as filesystem, block device, disk, partition or disk partition would all suit as well depending on use case.

I would keep volume there.

image

@bl-ue
Copy link
Contributor

bl-ue commented Feb 1, 2021

@peterbabic - Looks good to me, except the sentence "A usual way to generate an fstab file, requires root permissions:" is a little inconsistent with the rest of our pages. If that is the most common example, then I think you should:

  1. Move the example to the top, so it's what the user sees first, and
  2. Change the example description to "Generate an fstab file (requires root permissions):"

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Looks pretty much good to go to me - I think we can probably merge this.

I've left a comment on the requires root permissions issue, but that doesn't necessarily need to block the merge of this PR - and I can see some significant discussion has already happened - so I'm leaning on the side of getting this merged sooner rather than later.

@bl-ue
Copy link
Contributor

bl-ue commented Feb 3, 2021

@sbrl that was actually already resolved :) - #5215 (comment)

Copy link
Contributor

@bl-ue bl-ue left a comment

Choose a reason for hiding this comment

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

Thank you @peterbabic, and welcome to tldr-pages!

@bl-ue bl-ue merged commit 81c139c into tldr-pages:master Feb 3, 2021
@sbrl
Copy link
Member

sbrl commented Feb 3, 2021

Ok, whatever was done there is fine then :-)

@bl-ue
Copy link
Contributor

bl-ue commented Feb 3, 2021

We picked not to use sudo because that command is normally run in a boot environment where tee may not be available.

@peterbabic peterbabic deleted the genfstab branch February 3, 2021 07:27
@peterbabic peterbabic mentioned this pull request Jun 27, 2021
6 tasks
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 or PRs adding a new page for a command.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants