search

bssw-tutorial / tutorial-management

An issues-only repository for overarching management of BSSw tutorial development and presentation
0 stars 0 forks source link

Better documentation for presentations.yml file #67

Open bernhold opened 2 years ago

bernhold commented 2 years ago

Need to clarify how to maintain this file. Probably also how it is used, by way of explanation of how it should be maintained. This is probably relevant to the presentations and bssw-tutorial.github.io repositories.

Here are the rules for changing presentations.yml: 1) If you change the title of the presentation, update it in presentations.yml 2) If you add a new presentation file to the repository, add a row to presentations.yml 3) If we decide to retire a presentation file, we will remove its row from presentations.yml

bernhold commented 2 years ago

@frobnitzem added documentation comments within the presentation.yml file in https://github.com/bssw-tutorial/presentations/pull/123 Thanks!

We probably also need to add something to https://github.com/bssw-tutorial/presentations/blob/main/README.md to explain the purpose for modifying (and when not), though I don't think we need the full details.

And https://github.com/bssw-tutorial/bssw-tutorial.github.io/blob/main/README.md probably needs a more detailed explanation of how the presentations.yml file is used (from the website building perspective) and what it is expected to contain.