Add a GitHub discussions badge to the README

[mjang]

I need to update this with the NGINX color code.

I don't claim to know any/all PR requirements -- I'm using this as a learning experience.

ref nginx/unit-docs#150

[ac000]

Please make the alt text GitHub Discussions

I think it would be better if the badge text read NGINX Unit rather than 'N Unit'.

Also the 'green' seems a little off, interestingly if you chop off the 'n' (and more) from green you get a better colour, e.g

https://img.shields.io/badge/N_Unit-discussions-gree

[mjang]

Thanks for finding the "closer" color. Not sure why, but it seems equivalent to https://img.shields.io/badge/N_Unit-discussions-g

The suggested alt text makes sense.

[ac000]

Hmm, actually I'm wondering if GitHub | discussions would make more sense than NGINX Unit | discussions?

What do other projects use?

[mjang]

@ac000 , from a UI Text PoV, we'll see this badge only in the README for this well-labeled NGINX repo. So I think it's OK to label this GitHub | discussions.

[ac000]

I think the commit subject would be better as

Add a GitHub discussions badge to the README

[mjang]

I think the commit subject would be better as

Add a GitHub discussions badge to the README

I agree and have updated the Git commit

[ac000]

How about we use

https://img.shields.io/badge/GitHub-Discussions-009639

For the badge URL?

(That's NGINX green, well the green from the N logo from the README anyway...)

[mjang]

You have a point. I've updated the color for all three badges, and they seem to more closely match the color of the NGINX logo:

[mjang]

OTOH, the text in the green part of the badges are a little more difficult to read? (#feEngineeringIsHarderThanItLooks)

[mjang]

For comparison, here's the "current" green in main

[mjang]

@ac000 , I'll go with whatever you prefer.

[ac000]

Ooh I like that!

The main problem though is that the 'CI' badge changes dynamically depending on whether the workflows pass or not.

According to it may may be doable using https://shields.io/badges/endpoint-badge

But I'd want this as two separate patches anyway, so do the first patch that just adds the new badge, using GitHub instead of NGINX Unit for the left-hand side of the badge.

Then we can look at re-colouring the others...

[mjang]

The main problem though is that the 'CI' badge changes dynamically depending on whether the workflows pass or not.

Hi @ac000, I didn't know this.

So I'll limit this PR to adding the GitHub Discussions badge. Since we want to "re-color" ( ;) ) the others, I'll set up a follow-up issue, #1306.

[ac000]

Actually, while you're at it, you could create another separate patch that adds a 'tooltip' for the repo status button, we have one for the CI button, something like "Repo Status - Active"

[ac000]

Hi @mjang

Looks good. Just one thing, as a general rule we use our corporate email addresses (@f5.com/@nginx.com) when committing.

You can set it in the unit repository via

$ cd /path/to/unit
$ git config user.email EMAIL-ADDRESS

You can also adjust your commit to use it with

$ git commit --amend --no-edit --author="NAME <EMAIL-ADDRESS>"

[mjang]

Hi @mjang

Looks good. Just one thing, as a general rule we use our corporate email addresses (@f5.com/@nginx.com) when committing.

Hi @ac000 . Thanks for the guidance. I've now updated the commit with my corporate email address. This should now be ready for approval.

[ac000]

• Rebased with master
• Added my s-o-b

$ git range-diff 5cae8086...98983f3f
-:  -------- > 1:  e77a0c16 Tests: explicitly specify 'f' prefix to format string before printing
-:  -------- > 2:  c9dced37 Tests: print unit.log on unsuccessful unmount
1:  5cae8086 ! 3:  98983f3f Add a GitHub discussions badge to the README
    @@ Commit message
     
         - With NGINX green (hex code 009639)
     
    +    Signed-off-by: Andrew Clayton <[email protected]>
    +
      ## README.md ##
     @@