Closed rgaiacs closed 4 years ago
Coming up with good and consistent topics for our repositories is also potentially related to this.
Members of the lesson infrastructure subcommittee have agreed to solicit input from the community to come up with guidelines and recommendations for keywords to use in our lessons and as GitHub topics.
I'll follow up by sending an email to the discuss mailing list: https://carpentries.topicbox.com/groups/discuss/Tf6e39c33983ade11
Status report: A quick, likely incomplete survey uncovers carpentry-lesson
, software-
& data-carpentry
, carpentries
already being in use.
As a minimum recommendation, please consider carpentries-lesson
. It could be useful for all lessons, because GitHub then generates a comprehensive topic page overviewing all SWCarpentry
, DataCarpentry
, LibraryCarpentry
etc. repos. What do you think?
The repo names and descriptions can then be CTRL
+F
-searched in the browser for programming language, Carpentry, subject, etc.
@zinnar has come up with a proposal for this, I'll put in more details before the meeting on Wednesday
After today's committee meeting, we will implement the following for our repositories:
All repositories get: carpentries
They also get either:
They get: community, lesson, education where appropriate
Carpentry community:
Language taught:
Skills taught:
Language of the lesson:
GitHub API documentation: https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository
What about forks with inofficial modificiations? Should they refrain from using the carpentry
-specific topics? I'm asking with
Does forked from...
on a topic's page indicate "inoffical" clearly enough?
GitLab has "tags" as well, but hidden. Maybe Carpentries people could upvote a feature request about making them more visible.
Has this been implemented? It's probably worth somebody with appropriate permissions going over repos in swcarpentry and datacarpentry to add the carpentry-lesson
topic, because it doesn't seem to be there.
And I've spammed everyone today :man_facepalming: - I didn't find this because I didn't look in the right place. I didn't think to look for an issue here. Well... sorry everyone. The reason for doing this was that I went through all the lessons in dc and sc to look for rmd lessons (i.e., not using jekyll). It was a manual task to check whether something was or wasn't a lesson. I found that some lessons were using lesson
as a topic, but not the majority, so I had to go repo-by-repo and looking at the files. I would have preferred to code something and let the code do that for me... but I didn't have any obvious pattern to use.
Some have tried to solve that today and found out that maintainers couldn't add these tags. Others issues has been closed (though not solved) - e.g., datacarpentry/python-ecology-lesson#423.
lesson
would embed our repos with others in the wider GitHub community. +1 for that / -1 for carpentries-lesson
.
This has now been submitted for comments to the Maintainers: https://github.com/carpentries/maintainer-RFCs/issues/5 Please provide feedback on the proposed topics for each lesson repository linked on that issue.
the topics have been added to the lessons
Related with https://github.com/swcarpentry/styles/pull/226.