Depends, Recommends, and "can learn about" #74

New Issue

Open

opened 2021-03-31 20:52:02 +00:00 by SusanQuigley · 1 comment

SusanQuigley commented

2021-03-31 20:52:02 +00:00

Owner

Update the config.yamls in the following folders:

checking - Has right topics. Needs recommended and dependencies.
intro - Has right topics. No Dependencies needed. We might consider some Recommended topics. 4/6/2020
jit - DONE 3/30/2021 (May need to work on recommended and dependencies)
translate - Has right topics. Need to correct recommended and dependencies.

Dependencies are the topics that the current topic depends on. People need to understand the info in the dependencies in order to understand the info in the current topic.
Recommended are what we recommend people read after reading the current topic.

It doesn't matter if "dependencies:" and "recommended:" are followed by nothing or by []. Nothing shows up in BIEL.

I will use [] for now in the config.yaml to show that I believe that nothing is needed.

Update the config.yamls in the following folders: **checking** - Has right topics. Needs recommended and dependencies. **intro** - Has right topics. No Dependencies needed. We might consider some Recommended topics. 4/6/2020 **jit** - DONE 3/30/2021 (May need to work on recommended and dependencies) **translate** - Has right topics. Need to correct recommended and dependencies. Dependencies are the topics that the current topic depends on. People need to understand the info in the dependencies in order to understand the info in the current topic. Recommended are what we recommend people read after reading the current topic. It doesn't matter if "dependencies:" and "recommended:" are followed by nothing or by []. Nothing shows up in BIEL. I will use [] for now in the config.yaml to show that I believe that nothing is needed.

SusanQuigley commented

2021-04-07 20:18:27 +00:00

Author

Owner

Change of Plans.
We won't use the config.yamls.
We'll just keep them because the renderer looks for them and we don't want to confuse it.

Instead of filling in topics for "dependencies" and "recommended,"
we'll add sentences to the actual pages saying something like these:

In order to understand this page, you may need to read [../topic/01.md] first.
You can learn more about [topic] on [../topic/01.md].
Next we recommend you learn about [Topic]

There probably won't be many recommends until we get to the JIT learning. (We have one on the last topic of COBT pointing to the Translation Theory and Practice Manual.)

**Change of Plans.** We won't use the config.yamls. We'll just keep them because the renderer looks for them and we don't want to confuse it. Instead of filling in topics for "dependencies" and "recommended," we'll add sentences to the actual pages saying something like these: * In order to understand this page, you may need to read [../topic/01.md] first. * You can learn more about [topic] on [../topic/01.md]. * Next we recommend you learn about [Topic] There probably won't be many recommends until we get to the JIT learning. (We have one on the last topic of COBT pointing to the Translation Theory and Practice Manual.)