Restructure content according to methodology #317

razvand · 2023-08-03T14:28:38Z

Restructure repository according to Open Education Hub Methodology.

gabrielmocanu

Rename the contentdirectory to chapters.
Restructure the drill directory as we discussed:

content/software-stack/system-calls/drills/
|-- basic-syscall/
|   |-- README.md
|   |-- support/
|   `-- solution/
|-- libc-syscall/
|   |-- README.md
|   `-- support/
`-- syscall-wrapper/
    |-- README.md
    |-- support/
    `-- solution/

razvand · 2023-08-10T12:18:03Z

@gabrielmocanu, I applied your comments. See the last two commits.

teodutu · 2023-09-12T13:54:56Z

@razvand add the Makefile and build files from the oer-template repo here so I can test this and merge it: open-education-hub/oer-template#9.

RazvanN7 · 2023-09-12T14:04:42Z

@teodutu this currently does not follow the structure stated in the methodology

teodutu · 2023-09-12T14:07:49Z

Yup, but at least it's closer. Restructuring the repo according to the updated methodology is probably an unrealistic goal until tomorrow.

github-actions · 2023-10-03T16:37:02Z

Published at http://open-education-hub.github.io/operating-systems/317/

Signed-off-by: Razvan Deaconescu <razvan.deaconescu@upb.ro>

Move the remaining media files into their subchapters according to the restructuring. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

The new structure of the repo means that media paths will differ between the stored and rendered slides, but MarkdownPP cannot make modifications to links to such files. This commit introduces a custom preprocessor that handles `!INCLUDE`s as well as changing the links to fit the path where the slides are build. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

It is useful for testing changes made to `config.yml` or written content files locally. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

Alex-deVis · 2023-10-10T10:50:53Z

@teodutu, @gabrielmocanu the rendered version link [1] does not work.

[1] http://open-education-hub.github.io/operating-systems/317/

gabrielmocanu · 2023-10-10T10:52:10Z

@teodutu, @gabrielmocanu the rendered version link [1] does not work.

[1] http://open-education-hub.github.io/operating-systems/317/

Render it again. Probably another PR was merged.

razvand · 2023-10-15T14:55:38Z

@teodutu , I'll check this later today, so we can integrate it.

…he methodology Update `config.yml` and the content folders to render the website according to the new methodology. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

github-actions · 2023-10-15T23:14:36Z

Published at http://open-education-hub.github.io/operating-systems/317/

teodutu · 2023-10-15T23:17:25Z

I finally fixed the errors. @razvand @Alex-deVis take a look at the restructured Software Stack chapter [1] and see if you like it.

[1] https://open-education-hub.github.io/operating-systems/317/Software%20Stack/

Alex-deVis · 2023-10-16T08:51:08Z

@teodutu, I think it would be better to put the Mini-libc project under software-stack/projects rather than software-stack/libc/projects as this is a project for the whole chapter, not only for that section.

I find it more intuitive for questions/ to contain a list of quizzes, each file named after the quiz, not after the chapter. If you want students to solve a certain question after reading a chapter you can simply reference it.
To put it simply: libc/drills/questions should contain 6 files (each being a quiz): printf() system call, strcpy() system call, printf() vs write() ...

Also, even if it is repetitive, I think it is a good idea to keep the Assignments page as it helps to find projects quickly.

These points aside, everything looks good and we should merge it ASAP. We can make changes based on live feedback in the following weeks.

teodutu · 2023-10-16T11:23:09Z

@Alex-deVis I think the subchapters need to be split into another category such that the sidebar looks like this:

Software Stack:
|-- Slides
|-- That other category
|   |-- Overview
|   |-- ...
|   `-- Applications
`-- Projects

How to name "That other category"?

teodutu · 2023-10-16T11:33:07Z

On second thought, I think we should stick to the methodology and nest mini-libc under libc because that's what is closest to it.

Alex-deVis · 2023-10-16T11:53:09Z

IMO the idea of a project is something tied to the chapter as a whole (in this case to Software Stack), but I do not mind the current form as long as we keep the Assignments section for accessibility.

teodutu · 2023-10-16T12:07:20Z

Whatever gets this merged faster.

…ining a single question This fits the methodology according to which there should be one only one question per file. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

github-actions · 2023-10-16T12:25:05Z

Published at http://open-education-hub.github.io/operating-systems/317/

Alex-deVis

Looks good.

… action PR open-education-hub#317 restructured the repository. A part of its changes meant removing the `chapters` directory. This commit fixes open-education-hub#340 by removing mentions to it from the `README.md` and from the labeler action. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

… action PR #317 restructured the repository. A part of its changes meant removing the `chapters` directory. This commit fixes #340 by removing mentions to it from the `README.md` and from the labeler action. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

Updated comment to reflect actual content in code. Signed-off-by: Tache Robert Andrei <tacheandu@gmail.com> Propagate changes to the repo's layout to the `README.md` and labeler action PR open-education-hub#317 restructured the repository. A part of its changes meant removing the `chapters` directory. This commit fixes open-education-hub#340 by removing mentions to it from the `README.md` and from the labeler action. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

… action PR open-education-hub#317 restructured the repository. A part of its changes meant removing the `chapters` directory. This commit fixes open-education-hub#340 by removing mentions to it from the `README.md` and from the labeler action. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

razvand added enhancement New feature or request area/content Content (Markdown) update labels Aug 3, 2023

razvand requested review from teodutu, gabrielmocanu and Alex-deVis August 3, 2023 14:28

razvand assigned RazvanN7 Aug 3, 2023

gabrielmocanu requested changes Aug 5, 2023

View reviewed changes

razvand mentioned this pull request Aug 10, 2023

Add reading section open-education-hub/methodology#13

Merged

razvand requested a review from gabrielmocanu August 10, 2023 12:17

github-actions bot added area/code Update or new source code support / solution files area/quiz Update or new quiz question labels Aug 11, 2023

teodutu added the needs-rendering The PR makes changes to the website that need to be rendered label Oct 3, 2023

razvand added 4 commits October 6, 2023 15:12

Rework 1st level directory structure

a1897d1

Signed-off-by: Razvan Deaconescu <razvan.deaconescu@upb.ro>

software-stack: Restructure lab contents

92f5ab0

Signed-off-by: Razvan Deaconescu <razvan.deaconescu@upb.ro>

software-stack: Restructure lecture contents

7a50b60

Signed-off-by: Razvan Deaconescu <razvan.deaconescu@upb.ro>

software-stack: Move mini-libc assignment as project

a7e5cd2

teodutu force-pushed the razvand/restructure-content branch from 70ee8ad to a7e5cd2 Compare October 6, 2023 12:18

teodutu added needs-rendering The PR makes changes to the website that need to be rendered and removed needs-rendering The PR makes changes to the website that need to be rendered labels Oct 6, 2023

teodutu added 3 commits October 9, 2023 10:14

comtent/software-stack: Add missing media for slides

5ac2ed2

Move the remaining media files into their subchapters according to the restructuring. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

infra: Add Makefile for building the website locally

479f078

It is useful for testing changes made to `config.yml` or written content files locally. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

github-actions bot added the kind/new New content / item label Oct 9, 2023

teodutu added needs-rendering The PR makes changes to the website that need to be rendered and removed needs-rendering The PR makes changes to the website that need to be rendered labels Oct 9, 2023

teodutu added the needs-rendering The PR makes changes to the website that need to be rendered label Oct 9, 2023

github-actions bot added the kind/improve Improve / Update existing content / item label Oct 10, 2023

config: Update config for the "Software Stack" chapter according to t…

3ccf924

…he methodology Update `config.yml` and the content folders to render the website according to the new methodology. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

teodutu force-pushed the razvand/restructure-content branch from a4bf51c to 3ccf924 Compare October 15, 2023 23:11

teodutu added needs-rendering The PR makes changes to the website that need to be rendered and removed needs-rendering The PR makes changes to the website that need to be rendered labels Oct 15, 2023

content/software-stack: Split question files into multiple ones conta…

fa6eee6

…ining a single question This fits the methodology according to which there should be one only one question per file. Signed-off-by: Teodor Dutu <teodor.dutu@gmail.com>

teodutu force-pushed the razvand/restructure-content branch from 26dc177 to fa6eee6 Compare October 16, 2023 12:21

teodutu added needs-rendering The PR makes changes to the website that need to be rendered and removed needs-rendering The PR makes changes to the website that need to be rendered labels Oct 16, 2023

This comment was marked as duplicate.

Sign in to view

Alex-deVis approved these changes Oct 16, 2023

View reviewed changes

teodutu merged commit d2ca79a into open-education-hub:main Oct 16, 2023
1 of 4 checks passed

teodutu mentioned this pull request Oct 23, 2023

Propagate changes to the repo's layout to the README.md and labeler action #342

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restructure content according to methodology #317

Restructure content according to methodology #317

razvand commented Aug 3, 2023

gabrielmocanu left a comment •

edited

Loading

razvand commented Aug 10, 2023

teodutu commented Sep 12, 2023

RazvanN7 commented Sep 12, 2023

teodutu commented Sep 12, 2023 •

edited

Loading

github-actions bot commented Oct 3, 2023

Alex-deVis commented Oct 10, 2023

gabrielmocanu commented Oct 10, 2023

razvand commented Oct 15, 2023

github-actions bot commented Oct 15, 2023

teodutu commented Oct 15, 2023 •

edited

Loading

Alex-deVis commented Oct 16, 2023

teodutu commented Oct 16, 2023

teodutu commented Oct 16, 2023

Alex-deVis commented Oct 16, 2023 •

edited

Loading

teodutu commented Oct 16, 2023

github-actions bot commented Oct 16, 2023

This comment was marked as duplicate.

Alex-deVis left a comment

Restructure content according to methodology #317

Restructure content according to methodology #317

Conversation

razvand commented Aug 3, 2023

gabrielmocanu left a comment • edited Loading

Choose a reason for hiding this comment

razvand commented Aug 10, 2023

teodutu commented Sep 12, 2023

RazvanN7 commented Sep 12, 2023

teodutu commented Sep 12, 2023 • edited Loading

github-actions bot commented Oct 3, 2023

Alex-deVis commented Oct 10, 2023

gabrielmocanu commented Oct 10, 2023

razvand commented Oct 15, 2023

github-actions bot commented Oct 15, 2023

teodutu commented Oct 15, 2023 • edited Loading

Alex-deVis commented Oct 16, 2023

teodutu commented Oct 16, 2023

teodutu commented Oct 16, 2023

Alex-deVis commented Oct 16, 2023 • edited Loading

teodutu commented Oct 16, 2023

github-actions bot commented Oct 16, 2023

This comment was marked as duplicate.

Alex-deVis left a comment

Choose a reason for hiding this comment

gabrielmocanu left a comment •

edited

Loading

teodutu commented Sep 12, 2023 •

edited

Loading

teodutu commented Oct 15, 2023 •

edited

Loading

Alex-deVis commented Oct 16, 2023 •

edited

Loading