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

[Documentation] Update bundler.io "How to create a Ruby gem with Bundler" part #1067

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Mth0158
Copy link

@Mth0158 Mth0158 commented Jan 5, 2023

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.

@Mth0158
Copy link
Author

Mth0158 commented Jan 5, 2023

@tnir I'll let you squash these commits, I have also included @olleolleolle last comment in this PR.

Copy link
Collaborator

@tnir tnir left a comment

Choose a reason for hiding this comment

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

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.

@tnir tnir added this to the Create missing parts 2023 milestone Jan 5, 2023
@Mth0158 Mth0158 changed the title 579 update creating gem doc [Documentation] Update bundler.io "How to create a Ruby gem with Bundler" part Jan 6, 2023
@Mth0158
Copy link
Author

Mth0158 commented Jan 6, 2023

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/.

@Mth0158
Copy link
Author

Mth0158 commented Feb 15, 2023

Hi @tnir
What should we do with this PR? :)

@@ -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.
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
* `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.
Copy link
Member

Choose a reason for hiding this comment

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

Minor: Place the colon outside of the formatting backticks.

Copy link
Member

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

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

I made comments but they're not blocking a merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants