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

Prerender sponsors for READMEs #619

Closed
1 task
nzakas opened this issue Aug 27, 2024 · 4 comments · Fixed by #638
Closed
1 task

Prerender sponsors for READMEs #619

nzakas opened this issue Aug 27, 2024 · 4 comments · Fixed by #638
Assignees
Labels
accepted enhancement New feature or request

Comments

@nzakas
Copy link
Member

nzakas commented Aug 27, 2024

What problem do you want to solve?

Right now, we have multiple repos that pull in the raw data JSON files for sponsors and then generate the same HTML to insert into the README. This requires us to duplicate a bunch of logic in every repo where we want sponsors displayed.

What do you think is the correct solution?

Generate the sponsors sections (headings and tables) and store in a file on the website so each repo can just fetch the file and insert it directly into the README.

Participation

  • I am willing to submit a pull request for this change.

Additional comments

Looking for a volunteer for this.

@nzakas nzakas added the enhancement New feature or request label Aug 27, 2024
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Aug 27, 2024
@amareshsm
Copy link
Member

I will work on this. This repository will include the logic to generate and update a file with sponsor content. In the other repositories, we will update the update-readme.js file to fetch the content from this centralized file. let me know if my understanding is correct. Also, could you clarify what you mean by "store in a file on the website"? I'm not entirely sure I understand.

@nzakas
Copy link
Member Author

nzakas commented Aug 27, 2024

Yes, that's correct.

What I mean is, we can build the file so it's accessible via https://eslint.org/sponsors.md.

@nzakas
Copy link
Member Author

nzakas commented Aug 27, 2024

Or, I suppose we could also just keep the file in the repository like we do with the data files now.

@amareshsm
Copy link
Member

Completed via #638

@github-project-automation github-project-automation bot moved this from Ready to Implement to Complete in Triage Oct 6, 2024
@amareshsm amareshsm linked a pull request Oct 6, 2024 that will close this issue
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted enhancement New feature or request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants