Skip to content

Commit

Permalink
build-blocks/conventions: Fill contents
Browse files Browse the repository at this point in the history
Fill contents of "Conventions" section in "Building Blocks" chapter.

Signed-off-by: Razvan Deaconescu <[email protected]>
  • Loading branch information
razvand committed Dec 28, 2023
1 parent b8668a6 commit 6c084cf
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions chapters/building-blocks/conventions/reading/read.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,24 @@
# Conventions

Owner: Răzvan Deaconescu
Reviewer: Alex Apostolescu
Throughout the methodology we will use certain words and structure for uniformity and readability.
We present here these conventions.

Details words, syntax, formatting used: educator, learner.
Anything else?
Throughout the text, as also laid out in [the "Overview" section](../../overview/reading/read.md) we will use the words **educator** and **learner**.
We consider these terms to be generic enough to encompass the larger types of deliverers and consumers of educational content: teachers, trainers, professors, mentors, presenters on one side, and pupils, trainees, students, mentees, apprentices on the other side.

The word **repository** is used to represent both an open source repository (such as those hosted on GitHub) and the complete collection of contents, disconnected from their storage environment.

Each topic is allocated it onw file / page, with liberal referencing of topics on other pages.
This keeps things all in one place, and it makes it easy for the reader to focus only on the topic of interest.

Where possible and relevant, [roles](../../../roles/overview/reading/read.md) are used to signal who is expected to do a specific action.

Existing repositories are used to showcase each content type or educational activity.
These demonstrate the practical implementation of that topic.
Existing repositories used as examples are:

- [the `operating-systems` repository](https://github.com/open-education-hub/operating-systems)
- [the `ccas` repository](https://github.com/open-education-hub/ccas)
- [the `binary-security` repository](https://github.com/open-education-hub/binary-security)

Concrete examples of directory structures and commands are being used as much as possible.

0 comments on commit 6c084cf

Please sign in to comment.