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
Update installation.md #6694
Update installation.md #6694
Conversation
While installing Jekyll on Linux, I have noticed that not all the necessary packages were specified in your guide, therefore I offer some updates.
docs/_docs/installation.md
Outdated
headers | ||
- [RubyGems](https://rubygems.org/pages/download) | ||
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v` and `make -v` in your system's command line interface) | ||
headers (ruby installation can check by running `ruby -v`, development headers can be checked on Ubuntu by running `apt list --installed ruby-dev`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- (ruby installation can check by running `ruby -v`,
+ (ruby installation can be checked by running `ruby -v`,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe it is better to make a Passive voice - "(ruby installation can be checked by running ruby -v
"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
of course.. I meant to type (ruby installation can be checked by running ruby -v
itself 😆 🤦♂️
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done! 👍
docs/_docs/installation.md
Outdated
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v` and `make -v` in your system's command line interface) | ||
headers (ruby installation can check by running `ruby -v`, development headers can be checked on Ubuntu by running `apt list --installed ruby-dev`) | ||
- [RubyGems](https://rubygems.org/pages/download) (which you can check by running `gem -v`) | ||
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v`,`g++ -v` and `make -v` in your system's command line interface) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is g++
necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
corrected grammar mistake
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sashabrava Thanks for the contribution.
We know Ruby is the hard part to get going.
At one point we'll have to split instructions for the different OS, all this stuff is mostly irrelevant for latest macOS or Windows. I'll happily accept a PR with a dedicated Install for Linux
or Install Ruby on your system
section with links to up to date guides for each OS.
Everything that can ease the getting started part.
@jekyllbot: merge +docs |
While installing Jekyll on Linux, I have noticed that not all the necessary packages were specified in your guide, therefore I offer some updates.