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

Add info and fix command description [ci-skip] #45336

Merged
merged 1 commit into from Jun 13, 2022
Merged

Add info and fix command description [ci-skip] #45336

merged 1 commit into from Jun 13, 2022

Conversation

siaw23
Copy link
Member

@siaw23 siaw23 commented Jun 12, 2022

Summary

Other Information

@rails-bot rails-bot bot added the docs label Jun 12, 2022
Copy link
Member

@jonathanhefner jonathanhefner left a comment

Choose a reason for hiding this comment

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

Some small tweaks, but looks good! 👍

When you're happy with all the changes, would you mind squashing the commits?

@@ -42,13 +42,13 @@ $ rails new commandsapp
run bundle install
```

Rails will set you up with what seems like a huge amount of stuff for such a tiny command! You've got the entire Rails directory structure now with all the code you need to run our simple application right out of the box.
Rails will set us up with what seems like a huge amount of stuff for such a tiny command! We've got the entire Rails directory structure now with all the code we need to run our simple application right out of the box.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Rails will set us up with what seems like a huge amount of stuff for such a tiny command! We've got the entire Rails directory structure now with all the code we need to run our simple application right out of the box.
Rails will set up what seems like a huge amount of stuff for such a tiny command! We've got the entire Rails directory structure now with all the code we need to run our simple application right out of the box.


| Argument | Description |
| ----------------------- | ----------------------------------------------------------- |
| `--skip-git` | Skip .gitignore file |
| `--skip-git` | Skip git init, .gitignore, and .gitattributes |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| `--skip-git` | Skip git init, .gitignore, and .gitattributes |
| `--skip-git` | Skip git init, .gitignore, and .gitattributes |

@@ -65,6 +65,8 @@ If you wish to skip some files or components from being generated, you can appen
| `--skip-system-test` | Skip system test files |
| `--skip-bootsnap` | Skip bootsnap gem |

INFO: These are just some of the options you can append to `rails new`. For a comprehensive list of options, type `rails new --help`.
Copy link
Member

Choose a reason for hiding this comment

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

Let's skip the INFO: callout here. I don't think it adds anything, and too many callouts in a guide can be distracting.

Suggested change
INFO: These are just some of the options you can append to `rails new`. For a comprehensive list of options, type `rails new --help`.
These are just some of the options that `rails new` accepts. For a full list of options, type `rails new --help`.

@siaw23
Copy link
Member Author

siaw23 commented Jun 13, 2022

I think I'm happy with the changes now :) @jonathanhefner

@jonathanhefner jonathanhefner merged commit 53efecd into rails:main Jun 13, 2022
@jonathanhefner
Copy link
Member

jonathanhefner commented Jun 13, 2022

Thank you, @siaw23! 🎉

(Backported to 7-0-stable.)

jonathanhefner added a commit to jonathanhefner/rails that referenced this pull request Jun 25, 2022
Add info and fix command description [ci-skip]

(cherry picked from commit 53efecd)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants