-
Notifications
You must be signed in to change notification settings - Fork 31
Add projects data file and revamp Projects page #123
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
Add projects data file and revamp Projects page #123
Conversation
Signed-off-by: Eric Gregory <egregory04@gmail.com>
Signed-off-by: Eric Gregory <egregory04@gmail.com>
Signed-off-by: Eric Gregory <egregory04@gmail.com>
|
Great idea, @ericgregory -- and nice to have this be managed, configured, and generated as part of building the site. As it happens there are other ideas afloat regarding how we list and describe our projects. I'll ping you separately so we can strategize on that work and fold in the examples you've mentioned here. Thank you! |
Signed-off-by: Eric Gregory <egregory04@gmail.com>
|
Hi @disquisitioner -- I've made several updates per our last conversation! The latest commit...
|
|
Looks good @ericgregory -- thanks! This gets us the revised Projects page structure we'd discussed, preserving the existing aspects and making it possible to mention all our projects (even though that makes the page longer overall). I like that each project mentioned can link to its website, repo, and docs. Perhaps over time we can round that out for more projects and add other info there, e.g. Zulip channel, relevant SIG, etc. Thanks for adjusting the FAQ on the home page too. While we're not planning to do it now, I presume it'd be reasonably straightforward later on to add a way to tag projects and reflect their type, language, etc. I like that dynamically generating the page from data makes that possible. For now we'll maintain the _data/projects.yml file manually but look for a time in the future to generate that via an action based on a master list in the governance repo, correct? In terms of timing for publishing this PR, at the moment we haven't formally announced any Core Projects though are coordinating with folks to do that and hopefully very soon. Let me check on that and get back to you. |
|
If this was waiting for bytecodealliance/governance#124, that is merged now. |
|
Thanks, @abrown! I don't see any reason why you can't proceed and merge this PR @ericgregory, given the last bits of the Core Project approval process have now been completed. Thanks for putting this together! |
|
@disquisitioner Thanks! I don't have merge powers -- would you be able to merge this? |
|
Successfully merged and deployed -- thanks @ericgregory! |
This PR starts the work of revamping the Projects page to be a) comprehensive and b) a more useful tool for project discovery.
The update adds all of the projects listed in the governance/projects document, but the most important piece is that it adds projects via a project data file (
_data/projects.yml), so we can easily change how we actually present the projects in the future. (For example, a next step might be to organize projects by category on the Projects page, filtering by labels in the data file.) It also suggests a path for automating updates from the centralized governance repo in the future (i.e. a yaml file could be maintained there and then piped in to this repo via workflow).