urlstechie / urlchecker-action

:octocat: :link: GitHub action to extract and check urls in code and documentations.
https://urlchecker-python.readthedocs.io
MIT License
34 stars 12 forks source link

Examples table #63

Closed maelle closed 4 years ago

maelle commented 4 years ago

Fix #62

maelle commented 4 years ago

Given the examples don't all use the latest version of the action, I was wondering whether this makes sense (as opposed to making the table for a test repo whose workflows would be kept up-to-date). :thinking: At the same time it's nice to see others have adopted it as a complement to GitHub search.

SuperKogito commented 4 years ago

You make a great point but sadly I don't have a clear answer to this. My idea/ vision for the test-repo is to have a packed workflow exploring/testing almost all variant/inputs of the action. The workflow will be triggered by any new release of the action, that way we will be the first to test the action. I am still not sure about how all this will look like once implemented and whether it will cause a conflict against your suggestion, that's why I cannot tell for sure. @vsoch will surely provide a nice input on this.

vsoch commented 4 years ago

I didn't even see this! The table is missing some spacers, I checked it's rendering and it's off a bit :)

image

vsoch commented 4 years ago

Oops nevermind, bad copy paste! Here is how it looks

image

maelle commented 4 years ago

Done! :heavy_check_mark:

SuperKogito commented 4 years ago

I prefer the long name, not everyone know about the abbreviations plus that's the name on the organization page, so i don't see why do we favor the abbreviations? same for r-hub.

vsoch commented 4 years ago

Here is the final table! The spacing is just right now, aesthetically pleasing. image

The one future tweak we can do is to give that table it's own proper section - in my PR #64 I was calling it "In the Wild" or something like that.

maelle commented 4 years ago

And there could also be a sentence linking to a GitHub search of YAML files mentioning the action. 🤔

maelle commented 4 years ago

Was @superkogito answer above missed?

maelle commented 4 years ago

(R-hub is not an abbreviation though)

vsoch commented 4 years ago

I'm a part of us-rse, so I think I can solidly say that it's referred to very commonly as us-rse, especially around documentation for the organization and on GitHub. So that along with how much nicer the table renders is a good call I think. I wrote that original link also, and while it might be appropriate for a single list of names, it makes the table look weird to have it so long!

@maelle that would be a good idea too!

vsoch commented 4 years ago

I also don't think people looking for examples care so much about a specific org (they'd rather see an example) and if they do, they can click the link and read the full (extremely long!) name, lol.

SuperKogito commented 4 years ago

I still disagree xD but two votes beat one, so we can to other things ;)