chore(site): edit GitHub links (#3210)

[isaaccloos]

Overview

Populate a new page field 'hyper_path' for copied contrib files. Conditionally link back to hyper if a 'hyper_path' is present, otherwise continue to reference hyperium.github.io (relevant for all collections besides contrib).

Addresses hyperium/hyper#3210

Thought process

There are several interesting manipulations that happen within contrib.yml. These new additions should account for files that are:

• renamed (README -> index)
• copied / moved (CONTRIBUTING -> docs/contributing)
• in a separate repository (specifically hyper)

Testing

I've been testing these changes in remote containers, but I'm interested to verify with the real workflow 🧪 🔬

Criticism Welcome 😄

I thrive on feedback, please let me know if you'd like to see any changes to meet the criteria 👍🏻

[oddgrd]

Hey @isaaccloos, thanks for this! I'll need to get reacquainted with sed and jekyll to comment on the changes (even though it's just been a few months since I worked on this 😅). Before I do that I just wanted to mention that you should be able to run and test the workflow on your fork.

[isaaccloos]

Welp, I certainly felt the burn of blindly adapting a workflow to a separate solution 💀. Please let the grace of squash erase this debris 🧹.

Before I do that I just wanted to mention that you should be able to run and test the workflow on your fork.

This comment is absolutely fascinating to me. After poking around in my fork and searching online a bit I have yet to discover how I can tap into the included workflow items from the actions tab on GitHub. If you have any insight I'd be excited to learn something new 🚀

[oddgrd]

You may have to work on main (master) for the workflows to run, that's what I did. There are also some settings for actions under settings/actions in the fork you may need to tweak. You can see some action runs I did for testing on my fork here: https://github.com/oddgrd/hyperium.github.io/actions

[isaaccloos]

Thanks for the support!

Sadly, I believe I was experiencing a bug, or perhaps a nuance of GitHub that I still don't understand 🤪. After some head scratching I gave the default branch a love tap commit and 💥 the CI showed up and is available for all branches. This is just conjecture, but I'm leaning toward my usage of GitHub cli for creating forks as the root of this issue. I have done a few other tests using the website interface to create forks and the workflows were visible no problem. Curious indeed.

I'm excited to improve my methodology in this way 😄 Should be particularly useful for hyperium/hyper#3099

[seanmonstar]

Thanks so much for jumping on this! Does your recent comment suggest you've seen it working now?

[isaaccloos]

I believe I am seeing good results from these changes. I have put together a collection of resources to demonstrate their effects¹.

• Here you can see a PR within my fork that shows what would currently be updated in the _contrib folder if the contrib.yml file were accepted/run.

• Here is a fork of this project that has the _contrib folder updates AND the footer changes, reflecting all work in this PR. You can pull this down and, assuming you have the necessary Jekyll tooling installed², run it to play with test the results 😄.

Footnotes

1. Please let me know if there is a preferred method for demonstrating work. I'd be happy to make tests, screenshots, do some light hosting, etc. 👍🏻 ↩

2. I followed these installation instructions ↩

[seanmonstar]

Stupendous work, thank you!

I greatly appreciate your attitude and willingness to fully explain out what you've tried, it makes reviewing a joy.