Proposal to Enhance Resource Visibility through GitHub Pages Integration

[rickstaa]

Hey @dob,

Firstly, I want to express my gratitude for developing this remarkable resource; it's invaluable. I've been thinking about ways to enhance its visibility and user engagement. One idea that came to mind is transforming the current README into a more dynamic and visually appealing GitHub Pages site. This approach could significantly boost its accessibility and attract a wider audience 🚀.

As a successful example, please refer to https://adsb.cool, which hosts https://github.com/rickstaa/awesome-adsb showcasing the effectiveness of this method. Hosting the site at https://livepeer.cool would make it more discoverable and provide a more interactive and user-friendly experience. Setting up GitHub Pages is a straightforward process, and the benefits of visibility and user engagement could be substantial 🤔.

This enhancement could play a pivotal role in elevating the resource's impact. Your thoughts and considerations on this suggestion would be greatly appreciated.

[dob]

Thanks @rickstaa. I am all for any improvements to the visibility of this page. Another goal would be increased contributions to this page (people submitting issues to PRs to add useful new resources or remove outdated ones).

I'd welcome you, or anyone, taking the lead on the pages project. I think the requirements would be:

• Adding or removing a resource is still a one-line-ish PR so that anyone can do it whether technical or not
• The design is unopinionated and easy to maintain so that it the page doesn't break entirely if the initial implementor loses interest in the project.

[rickstaa]

@dob,

I've promptly assembled a Proof of Concept (POC) for the GitHub Pages deployment. You can access the branch for this version at https://github.com/rickstaa/awesome-livepeer/tree/add_github_pages_site, and the deployed site is available at https://rickstaa.dev/awesome-livepeer. If you give the green light, I'll go ahead and finish the remaining tasks outlined below, and we can integrate them into the main branch.

Concerning your inquiries:

1. Maintaining Accessibility: The process of adding or removing a resource remains uncomplicated, requiring just a one-line pull request. This approach ensures accessibility for both technical and non-technical contributors.
2. Sustainable Design: The project's design remains neutral and easily maintainable. The README.md requires no changes; it will continue to operate smoothly. For the website design, I've adopted the default Jekyll style without any customizations (you can review it at https://github.com/rickstaa/awesome-livepeer/blob/add_github_pages_site/assets/css/styles.css).

Remaining Tasks:

To conclude this user story, we need to address the following:

• [x] Rectify the linting errors identified by the awesome-lint action (details available at https://github.com/sindresorhus/awesome-lint).
• [x] ~Implement necessary adjustments to align with the awesome guidelines (please refer to https://github.com/sindresorhus/awesome/blob/main/contributing.md). This will facilitate the inclusion of our list in https://github.com/sindresorhus/awesome, enhancing its visibility and exposure.~ - It looks like they don't accept blockchain-related lists 😕 (see https://github.com/sindresorhus/awesome/blob/main/pull_request_template.md#requirements-for-your-pull-request).
  • [ ] The repo should have awesome-list & awesome as GitHub topics.
  • [x] Includes a project logo/illustration whenever possible.
• [x] ~If feasible, transition the license from MIT to CC0. This step is crucial if we plan to feature the list on https://github.com/sindresorhus/awesome.~ https://github.com/sindresorhus/awesome does not accept blockchain-related lists that are currently unnecessary.

Kindly evaluate the POC, and don't hesitate to provide your feedback 👍🏻.

[rickstaa]

I now use the following logo, which I found in your branding folder. If your marketing team a better banner please let me know 👍🏻.

[rickstaa]

@dob I had 10 minutes to finish the lining errors and add a logo. I created https://github.com/livepeer/awesome-livepeer/pull/7 for you to review. Please let me know if there are any changes you would like me to make 👍🏻.

[dob]

@rickstaa #7 is merged. I do see some failing linting errors on the merge itself. Any insight into how to avoid those in the future?

Also, want to include this updated logo? One candidate .jpg and one raw vector image attached...

[rickstaa]

Thank you for successfully merging Pull Request (PR) #7 🚀. I added a quick explanation below about the lining action and the thrown errors.

Logo update

The logo can be updated to any preferred design, as indicated here:

https://github.com/livepeer/awesome-livepeer/blob/e4d934bf667f6d910f2270372cc6848a8c1e6bab/README.md?plain=1#L11

However, when viewing the README directly, the current logo could render better on GitHub's dark theme. On the website, the appearance is satisfactory:

One possible improvement would be to decrease the width a bit:

A viable solution to ensure the logo's compatibility across the README and the website is to introduce a white background.

Please advise on your preferred logo version, and I will create a Pull Request accordingly 👍🏻.

Linting action

*Comprehensive Analysis of Linting Errors:

Our GitHub Actions workflow is integral for upholding the repository's standards, comprising two pivotal jobs:

1. Awesome List Conventions Check:

   • Tool Utilized: awesome-lint rigorously examines the README to ensure adherence to the Awesome List conventions.
   • Current Status: I have rectified all identified issues except for adding the awesome and awesome-list topics to the repository. This still needs to be addressed due to my lack of the requisite permissions.

   Reference Documentation: awesome-livepeer/lint.yaml#L8-L24.

2. Broken Links Check:

   • Tool Deployed: awesome-bot ensures all README links are accessible.
   • Identified Issues: Two broken links have been detected. Efforts to rectify these are ongoing:
     • [L049] https://www.lensplay.xyz/ - Communication has been established with the content creators regarding an SSL error. A response is awaited.
     • [L145] https://livepeer.academy/ - @titannode has been informed of an expired SSL certificate.

   Reference Documentation: awesome-livepeer/lint.yaml#L25-L46.

To tackle the first broken link, I have initiated PR #9 to propose the removal of https://www.lensplay.xyz, contingent upon the SSL certificate renewal by @titannode for https://livepeer.academy.

Proposed Enhancements:

• Dedicated Action for awesome-bot: Isolating the awesome-bot check will allow us to check for broken links periodically instead of on merge or commits pushed to the main branch (see https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule). I'm happy to create a pull request 👍🏻.

[rickstaa]

@dob could you add the awesome and awesome-list labels to this repository so that the Lint action passes? Thanks 🙏🏻.

[dob]

@dob could you add the awesome and awesome-list labels to this repository so that the Lint action passes? Thanks 🙏🏻.

Done.