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.

Sign up for GitHub

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 creating_gem.en.html.md #579

Closed
wants to merge 2 commits into from
Closed

Update creating_gem.en.html.md #579

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e0dc4c
Update creating_gem.en.html.md
Mth0158 Jun 8, 2021
34dac52
Updated with tnir's comment
Mth0158 Jul 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions source/localizable/v2.2/guides/creating_gem.en.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,13 @@ 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:
* *summary:* A short summary of your gem's description.
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
* *summary:* A short summary of your gem's description.
* `summary`: A short summary of your gem's description.

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

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

Suggested change
* *homepage:* The URL of your gem's home page, it can be the URL of its website or public repo
* `homepage`: The URL of your gem's home page, it can be the URL of its website or public repo.

* *metadata["allowed_push_host"]:* The field allows you to restrict gem pushes to a single host. If you are not running your own gem server you should comment this line, otherwise you will not be able to push your gem to rubygems.org.
Copy link
Member

Choose a reason for hiding this comment

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

running your own gem server

That's really advanced stuff for beginner. Is there any chance to reword this to make it clear by allowing rubygems.org you'll be able to push to public (accessible by everyone) repository and this is needed for this guide to be able to publish in the end?

* *metadata["source_code_uri"]:* The URL of your gem's 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.

Suggested change
* *metadata["source_code_uri"]:* The URL of your gem's public repo
* `metadata["source_code_uri"]`: The URL of your gem's public repo.

* *metadata["changelog_uri"]:* The URL of your gem's CHANGELOG.md
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
* *metadata["changelog_uri"]:* The URL of your gem's CHANGELOG.md
* `metadata["changelog_uri"]`: The URL of your gem's CHANGELOG.md.


* **lib/foodie.rb**: The main file to define our gem's
code. This is the file that will be required by Bundler (or any similarly smart system) when our
Expand Down