Add community section #100
Conversation
For listing Fortran-lang community projects; this will hold information on contributing, code of conduct and current contributors.
Reads github_stats json files and produces list of contributors and plots which can be filtered by repository and date window.
Update main.css for better vertical-alignment of feather icons with text.
Simplify html-side of contributor plots. Start cleanup of javascript.
Add new features to previous newsletter to demonstrate inclusion of contributor info.
Move script parameters into namespace global options structure at beginning.
Add library of site-wide javascript functions, including jekyll parameters. This avoids the need to have other javascript files processed by jekyll templating.
Add text for how to start contributing.
The generated package list is now a proper JSON file. Package search updated to load json file and remove global scope.
Restructures the package page without the community projects, which have moved to community page.
|
#build_preview |
|
This PR has been built with Jekyll and can be previewed at: https://fortran-lang.org/pr/100/ |
|
Great new page! |
|
This is excellent, thank you Laurence. Very nice contribution graphs. Are contributions == commits + comments? |
Thanks! |
There was a problem hiding this comment.
The graphs look absolutely awesome. Much better than I've been imagining. Thank you @LKedward. As far as it looks, I am definitely for merging.
Some organizational things that we should discuss:
-
Modifying already published newsletters, I left a comment below.
-
The JSON files seem to be checked in this repository. Is the idea that we will keep updating them here by submitting PRs? It might work, that way it's clear exactly what the data is, and it's also clear when we update it, and the whole community can see / check that the updates are correct. What I was imagining before is that the JSON files would be hosted in another repository, and freshly downloaded at the CI when this website is built. But then the other repository must be updated, so we might as well just update this repository directly. So I think it's fine with me as it is. The only real downside that I can see is that the JSON files are quite big and will only get bigger in the future.
-
Is the standard practice to check in all the JavaScript libraries? Or can they be simply downloaded by the CI. It would reduce the size of this repository.
|
This is really cool. I think it helps to gameify things enough to keep us all coming back and contributing. And the more we keep contributing the better it will get and the more it will grow and then turn into a virtuous cycle. Great addition. |
|
@everythingfunctional you got the idea. We want people to feel proud and excited to be visible there. |
This avoids page lag due to waiting on the main thread and is recommended practice.
This reverts commit ef7c48f.
|
#build_preview |
|
This PR has been built with Jekyll and can be previewed at: https://fortran-lang.org/pr/100/ |
|
Thanks for the feedback! Regarding the javascript library and JSON data files, I agree that these should ideally be left out of this repository - CI downloading is an option, but we also don't want the CI environment to be able to diverge from the local clones, i.e. we need a solution that brings dependencies into the local repos as well. My preferred solution to this would be to use git submodules, however I'm aware that some people do not like submodules. I personally have never had any problems with submodules and the advantage here is that it minimally affects contributor workflow while also allowing dependencies in separate repos. |
|
I think this can be merged as far as I am concerned. I personally am not a big fan of submodules, it's an extra struggle. But I am also not against it, and I think it technically does what we need: keeping the big files out of the repository. And since you are @LKedward the main contributor to this website (as apparent from the statistics in this PR:), and you like submodules, then let's use them. If too many people struggle with them, we can always move to another solution later. Thanks again for this PR. |
|
I have good success using submodules as a dependency management strategy. I would vote for using them. As @certik said, we can move to something else later if need be. |
|
Okay I will merge and open a new issue for the external dependencies. |
|
#delete_preview |
|
The preview build for this PR has now been deleted. |
This PR creates a new top-level page called 'Community' for the Fortran-lang projects in order to:
The PR includes json data files from https://gitlab.com/fortran-lang/github_stats_data which is used to generate the contributor lists and plots. On the new community page you can use the slider beneath the aggregate plot to filter contributions by a specific date range.
The contributions list can also be incorporated into newsletters with a fixed date range, which I have done for the June newsletter as an example.
Work for future PRs will be:
As always, I value feedback on this - my focus has been on the structure and implementation, so any suggestions for the text content are especially welcome.
(Apologies for the size of this PR, it grew to more than I was initially planning to organise and cleanup the javascript files.)