[Documentation] Update bundler.io "How to create a Ruby gem with Bundler" part #1067
Conversation
|
@tnir I'll let you squash these commits, I have also included @olleolleolle last comment in this PR. |
There was a problem hiding this comment.
Thanks @Mth0158 for contributing to improve this document.
I think the full list has been available at https://guides.rubygems.org/specification-reference/ . Why did you choose these five fields to add into this place?
Also I would like to update the PR title more properly if you continue this PR.
Mth0158
changed the title
|
Hi @tnir, This PR might have been made before these changes you mentioned were added onto Rubygems (unsure but plausible). However, these changes will apply to https://bundler.io/guides/creating_gem.html, that is what I used back then when I tried to create my gem and I thought the information mentioned in my PR was missing, therefore the PR. I could update my PR to duplicate the information present on https://guides.rubygems.org/specification-reference/. |
|
Hi @tnir |
| @@ -83,6 +83,12 @@ extension and the _.bundle_ directory. | |||
| * **foodie.gemspec**: The Gem Specification file. This is | |||
| where we provide information for Rubygems' consumption such as the name, description and homepage | |||
| of our gem. This is also where we specify the dependencies our gem needs to run. | |||
| * Fields to complete: | |||
| * `description (optional):` A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. | |||
There was a problem hiding this comment.
| * `description (optional):` A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. | |
| * `description` (optional): A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. |
| @@ -83,6 +83,12 @@ extension and the _.bundle_ directory. | |||
| * **foodie.gemspec**: The Gem Specification file. This is | |||
| where we provide information for Rubygems' consumption such as the name, description and homepage | |||
| of our gem. This is also where we specify the dependencies our gem needs to run. | |||
| * Fields to complete: | |||
| * `description (optional):` A long description of your gem. The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting. | |||
| * `homepage:` The URL of your gem's home page, it can be the URL of its website or public repo. | |||
There was a problem hiding this comment.
Minor: Place the colon outside of the formatting backticks.
Making a proposal to update the wiki from this issue: Issue 4458
The descriptions of the fields to complete come from Rubygems.
Mth0158
What was the end-user problem that led to this PR?
If metadata["allowed_push_host"] is not commented and you are not using your own ruby gem server you will not be able to push your gem to rubygems.org.
This causes an error that is not displayed on the CLI and is very confusing.
What was your diagnosis of the problem?
The diagnosis was previously made on the issue.
What is your fix for the problem, implemented in this PR?
To explicitly write in the wiki to comment this line in gemspec file if you do not use your own gem server.
Why did you choose this fix out of the possible options?
Making the tutorial a bit more user-friendy.