From b1ac2b128728d6147844cc785e111ca2a80330b2 Mon Sep 17 00:00:00 2001 From: Myron Marston Date: Fri, 25 Oct 2024 21:07:21 -0700 Subject: [PATCH] Update project links. - Link to the elasticgraph discord channel on the GraphQL discord. - Set the gem homepage and metadata URIs now that we have them. --- .github/ISSUE_TEMPLATE/config.yml | 2 +- CONTRIBUTING.md | 4 ++-- GOVERNANCE.md | 2 +- gemspec_helper.rb | 12 ++++++++++++ 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ce71f103..969a9abc 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ contact_links: - name: ❓ Questions and Help 🤔 - url: https://discord.gg/tbd (/add your discord channel if applicable) + url: https://discord.com/invite/c79mzZnu about: This issue tracker is not for support questions. Please refer to the community for more help. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f0bbc78..fc624249 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ There are many ways to be an open source contributor, and we're here to help you on your way! You may: -* Propose ideas in our discord +* Propose ideas in our [discord](https://discord.com/invite/c79mzZnu) * Raise an issue or feature request in our [issue tracker](https://github.com/block/elasticgraph/issues) * Help another contributor with one of their questions, or a code review * Suggest improvements to our Getting Started documentation by supplying a Pull Request @@ -54,7 +54,7 @@ Anyone from the community is welcome (and encouraged!) to raise issues via ### Discussions -Design discussions and proposals take place in our discord. +Design discussions and proposals take place in our [discord](https://discord.com/invite/c79mzZnu). We advocate an asynchronous, written debate model - so write up your thoughts and invite the community to join in! diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 6762a7db..7d9fa5e6 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -12,7 +12,7 @@ Anyone may be a contributor to Block open source projects. Contribution may take the form of: -* Asking and answering questions on the Discord or GitHub Issues +* Asking and answering questions on the [Discord](https://discord.com/invite/c79mzZnu) or [GitHub Issues](https://github.com/block/elasticgraph/issues). * Filing an issue * Offering a feature or bug fix via a Pull Request * Suggesting documentation improvements diff --git a/gemspec_helper.rb b/gemspec_helper.rb index b94e7488..9d4cc7b8 100644 --- a/gemspec_helper.rb +++ b/gemspec_helper.rb @@ -19,9 +19,21 @@ def self.define_elasticgraph_gem(gemspec_file:, category:) spec.version = ElasticGraph::VERSION spec.authors = ["Myron Marston", "Ben VandenBos", "Block Engineering"] spec.email = ["myron@squareup.com"] + spec.homepage = "https://block.github.io/elasticgraph/" spec.license = "MIT" spec.metadata["gem_category"] = category.to_s + # See https://guides.rubygems.org/specification-reference/#metadata + # for metadata entries understood by rubygems.org. + spec.metadata = { + "bug_tracker_uri" => "https://github.com/block/elasticgraph/issues", + "changelog_uri" => "https://github.com/block/elasticgraph/releases/tag/v#{ElasticGraph::VERSION}", + "documentation_uri" => "https://block.github.io/elasticgraph/docs/main/", # TODO(#2): update this URL to link to the exact doc version + "homepage_uri" => "https://block.github.io/elasticgraph/", + "source_code_uri" => "https://github.com/block/elasticgraph/tree/v#{ElasticGraph::VERSION}/#{spec.name}", + "gem_category" => category.to_s # used by script/update_readme + } + # Specify which files should be added to the gem when it is released. # The `git ls-files -z` loads the files in the RubyGem that have been added into git. # We also remove `.rspec` and `Gemfile` because these files are not needed in