Update Documentation and Installation pages #1877
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There’s no reason to spend so much time talking about installing Ruby or the command line on a page dedicated to documentation. We can refer people directly to the installation page which is much better suited to this.
These links are already available on every single page of the site in the sidebar, there’s no need to repeat them here.
I was surprised not to find these listed anywhere even though it is the official documentation built from source and hosted on ruby-lang.org Third parties are fine, but we shouldn’t link to third parties only if we offer this resource already.
There were a lot of outdated (and many may still remain) pieces of information in this guide and it was often needllessly verbose. I cut down on unnecessary copy, added relevant internal and external links, etc.
sorah
approved these changes
Nov 15, 2018
|
This looks great 😍👍 If there are new suggestions/fixes, anyone is free to open Pull Request and we keep moving forward. |
|
Thanks @sorah and @JuanitoFatas. I'm excited to get to clean up those pages a bunch. 🤗 Although heads up this might conflict a bit with #1835 which will probably need a rebase now. |
|
@ruby/www-ruby-lang-org-i18n-ko Documentation for Korean should be updated, please take a look. |
riseshia
added a commit
to riseshia/www.ruby-lang.org
that referenced
this pull request
Nov 17, 2018
riseshia
added a commit
to riseshia/www.ruby-lang.org
that referenced
this pull request
Nov 17, 2018
riseshia
added a commit
to riseshia/www.ruby-lang.org
that referenced
this pull request
Dec 3, 2018
riseshia
added a commit
to riseshia/www.ruby-lang.org
that referenced
this pull request
Dec 9, 2018
riseshia
added a commit
that referenced
this pull request
Dec 23, 2018
* [KO] Follow up changes of #1877 Ref: #1877 * Add faq * Add C API reference * Add Atom to list * Translate FreeBSD Ports Collection from https://docs.freebsd.org/doc/10.3-RELEASE/usr/local/share/doc/freebsd/ko/articles/contributing/ports-contributing.html * Add missing text * Use 모하브 as Mojave translation * Follow up dc375e4 * Prefer 가상 머신 than 가상 기기 for virtual machine * Fix more * Use korean link
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation
Installation
I know this is a lot for on PR but a lot of these changes are related and it seemed like we'd take a week of back and forth if I had made this multiple discrete PRs. I'm completely okay to discuss the merit of some of these changes in PR review comments. Please feel free to suggest more changes/updates to the Installation page for example as I'm not as familiar with Linux/Windows installation issues as I am with macOS ones.