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

include github contributors badge in docs site #10337

Merged
merged 1 commit into from
Jul 9, 2024

Conversation

chris48s
Copy link
Member

@chris48s chris48s commented Jul 5, 2024

Closes #10323
Refs #10322

This PR does two things:

  1. Include GitHub Contributors badge in docs site.
    Fundamentally, the Open API spec dictates that this must be laid out as an object keyed on the route so each route must be unique within each category. The way I've chosen to solve this is by renaming the param from variant to metric in this one case. I also considered moving one of the badges to a different category, but I think they do really both belong in Activity.
  2. Explain the difference between the two versions of this badge.

@chris48s chris48s added bug Bugs in badges and the frontend documentation Developer and end-user documentation labels Jul 5, 2024
@chris48s chris48s changed the title include gituhb contributors badge in docs site include github contributors badge in docs site Jul 5, 2024
Copy link
Contributor

github-actions bot commented Jul 5, 2024

Warnings
⚠️ This PR modified service code for github but not its test code.
That's okay so long as it's refactoring existing code.
Messages
📖 ✨ Thanks for your contribution to Shields, @chris48s!

Generated by 🚫 dangerJS against cd91cb5

Copy link
Member

@PyvesB PyvesB left a comment

Choose a reason for hiding this comment

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

Looks good to me! 👍

@chris48s chris48s added this pull request to the merge queue Jul 9, 2024
Merged via the queue into badges:master with commit e6c8d07 Jul 9, 2024
26 checks passed
@chris48s chris48s deleted the 10323-contribs branch July 9, 2024 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bugs in badges and the frontend documentation Developer and end-user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GitHub Contributors badges are not documented on website
2 participants