carpentries / community-facilitators-program

Repository with context, resources and curriculum for The Carpentries Facilitators Program
https://carpentries.github.io/community-facilitators-program/
Other
4 stars 0 forks source link

Sharing calendar invite, documents, email address, workshop slug, and other technical information #33

Open annajiat opened 2 years ago

annajiat commented 2 years ago

When using technical information or sharing among facilitators such as

For email addresses, it may be helpful to remove the name part and keeping only the email address in document/email body/invitation box. For example, someone@gmail.com instead of "Ms Some One" someone@gmail.com

It might be a good practice to confirm over email whether colleagues received some notification like calendar invite or a shared planning document for teaching the workshop instead of relying on the automatic notification.

Similarly, some instructors may not receive slack invitation due name getting merged with the email address for some reason leading to a wrong email address which could be an error difficult to correct. Deleting and re-inviting sometimes brings back the old incorrect email address. All pending invites in all channels needs to be canceled and the erroneous email address needs to be removed from all channels.

Workshop slug which is the identifier for a workshop. It is also used to create the GitHub repository / workshop webpage as well as to generate pre/post workshop survey links. An example of the slug could be: 2019-02-25-abcd-university-online

There are may be some workshop website repositories with undesired prefix or suffix which may be difficult to notice at first glance due to the small characters. Please find hypothetical examples below that can be tested at https://github.com/new Lets try creating a site with the slug 2019-02-25-abcd-university-online.

Desired repository name: 2019-02-25-abcd-university-online

Undesired but may be erroneously created repository: -2019-02-25-abcd-university-online.-
The leading and trailing "-" has been auto converted from the copied adjacent spaces to "-" by GitHub. Additionally the period/dot from the sentence also made it to the slug.

Once such an error has been made, it can be easily corrected. We might wish to add the topic "how to change the repository name" to instructor training as well as our git lessons. Here is the tutorial: https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/renaming-a-repository

bkmgit commented 2 years ago

Workshop slug can be validated using regex and deployment stopped if it does not match correct format.