Open sadasant opened 6 years ago
I'm all in for this format, although I'm a bit curious about what ideas do you have for essays
and tools
@aitbw here's an issue about some ideas for tools: https://github.com/tecnoyucas/meta/issues/7
Essays are going to be my favorite thing, I believe. I'm super curious about what we can come up with.
This is about the new format we need to come up with and agree. Here at the beginning we’ll have our latest agreements and below we will have commentary about it.
Current Idea:
Let’s make a github repo per release. Releases will take us 3 months to develop and will contain the following structure:
Where:
The rest will be folders with our different kinds of publications. In these folders, the publications will be folders themselves, with the following structure:
Where:
authorHandle
, as in Twitter or Github handle, otherwise his/her full name, joined with a dash with the title of the article.index.md
, which will hold the publication itself.references.md
file, which will hold links to external references, including links to other articles, documentations, essays, websites and more.tags.csv
file, which will contain a list of comma separated tags, to facilitate file searching.It's important to note that:
Branches
Our branches will be:
master
, which will have the publication in full once it's released.draft
, which will hold the current state of the publication. Work in progress, but everything merged has to have been agreed upon by members of the community.contentType/issueNumber
, branches for specific articles will be named by the type of the article and the number of the issue, an they will be merged into thedraft
branch.The
master
branch should have the following protections:The
draft
branch should have the following protections:Please share other approaches or improvements to this one.