DHRI-Curriculum / project-lab

Materials related to the Project Laboratory session of @DHRI-Curriculum
http://www.dhinstitutes.org
6 stars 10 forks source link

Create a meta.md file #17

Open kallewesterling opened 4 years ago

kallewesterling commented 4 years ago

Drawing on #11, #13, #14 to outline what a meta.md should look like.

Tagged with sprint 2 as I think this is something we might ask fellows to do in that sprint.

kallewesterling commented 4 years ago

So far we have:

kallewesterling commented 4 years ago

As referenced in #12, each of the sections need to be regularized (for programmatic population of database) and clearly communicated to the fellows.

See also project-lab's README.md for Lisa's draft of what a meta.md could look like.

kallewesterling commented 4 years ago

We have also discussed:

This, however, seems to pertain not to each workshop but to the project as a whole, and we might just want to hardcode this into the site — alternatively add another meta-layer for the website itself.

I could envision that there could be "standards" set up in the website meta layer, that could be overridden, for example, by an individual workshop. User stories (sort of):

kallewesterling commented 4 years ago

In #13, you had asked for a more visual way of seeing how this ties in with everything, @lmrhody.

I spent two hours this morning drawing up some wireframes. They're pretty hefty, so the image made my computer a little laggy... If you right-click and save the file on your Mac, and then opening it in Preview, it might work better than looking at it in the browser:

https://raw.githubusercontent.com/DHRI-Curriculum/django-app/alpha-1/sketches/alpha-1-sketches-june-17.png

They might be good for us to have in our meeting tomorrow, as this is how I have envisioned how we can move the current GitHub curricular materials into a django site. But consider them suggestions—feel free to draw, on top or annotate the image however you see fit, and either send back to me (via Slack/email) or just add to the sketches directory on the django-app repo.

kallewesterling commented 4 years ago

This is also where we want to include warnings/known compatibility issues:

https://github.com/DHRI-Curriculum/django-app/issues/87

kallewesterling commented 4 years ago

Testing out here: https://github.com/DHRI-Curriculum/project-lab/blob/v2.0-kalle-testing-lessons/meta.md

kallewesterling commented 4 years ago

Instead of referring to next/previous workshops, as I wrote 10 days ago, I think we might want to consider a Tracks app for the django site instead: https://github.com/DHRI-Curriculum/django-app/issues/139

kallewesterling commented 3 years ago

@lmrhody I am also revisiting this workshop now, before you finish this up, and to test-ingest it into the website before I leave the project. Thus, changing things around. Some of the things you had added to the README.md will not be ingested since some of the sections were not formalized in our work last summer (for example, "History", "How to use this workshop", "How to contribute to this workshop", and "Contact Us" + the licensing information). Rather, we had discussed adding this as yet another file in the repositories (see this issue). Thus, I'll move things around a bit.

Before you start editing, I would therefore recommend that you pull the workshop on Monday or early in the week from GitHub, so as to not end up with a whole lot of patching between files.