From 3ffdc88295b614ee38c9171dc385c275a6b66d7f Mon Sep 17 00:00:00 2001 From: Mth0158 Date: Tue, 19 Jul 2022 19:50:59 +0200 Subject: [PATCH 1/3] Updated with tnir's comment --- source/localizable/{v2.2 => }/guides/creating_gem.en.html.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename source/localizable/{v2.2 => }/guides/creating_gem.en.html.md (100%) diff --git a/source/localizable/v2.2/guides/creating_gem.en.html.md b/source/localizable/guides/creating_gem.en.html.md similarity index 100% rename from source/localizable/v2.2/guides/creating_gem.en.html.md rename to source/localizable/guides/creating_gem.en.html.md From e00127ffa2e826785b0d5303d1946ed2b55fd41f Mon Sep 17 00:00:00 2001 From: Mth0158 Date: Thu, 5 Jan 2023 11:12:21 +0100 Subject: [PATCH 2/3] [Documentation] Update creating_gem.en.html.md --- source/localizable/guides/creating_gem.en.html.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/localizable/guides/creating_gem.en.html.md b/source/localizable/guides/creating_gem.en.html.md index 1d593c07ba..0a8c0248f1 100644 --- a/source/localizable/guides/creating_gem.en.html.md +++ b/source/localizable/guides/creating_gem.en.html.md @@ -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. + * *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 + * *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. + * *metadata["source_code_uri"]:* The URL of your gem's public repo + * *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 From 965afeaee1b7a27757f3af7eecb4a008ebbbaaea Mon Sep 17 00:00:00 2001 From: Mth0158 Date: Thu, 5 Jan 2023 11:19:37 +0100 Subject: [PATCH 3/3] Add olleolleolle suggestions --- source/localizable/guides/creating_gem.en.html.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/source/localizable/guides/creating_gem.en.html.md b/source/localizable/guides/creating_gem.en.html.md index 0a8c0248f1..7fb31c20e3 100644 --- a/source/localizable/guides/creating_gem.en.html.md +++ b/source/localizable/guides/creating_gem.en.html.md @@ -84,12 +84,11 @@ extension and the _.bundle_ directory. 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. - * *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 - * *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. - * *metadata["source_code_uri"]:* The URL of your gem's public repo - * *metadata["changelog_uri"]:* The URL of your gem's CHANGELOG.md + * `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. + * `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. + * `metadata["source_code_uri"]:` The URL of your gem's public repo. + * `metadata["changelog_uri"]:` The URL of your gem's CHANGELOG. * **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