search

openedx / docs.openedx.org

[BETA] A new home for learning about Open edX
https://docs.openedx.org
Other
6 stars 53 forks source link

docs: Add details for mounting other repos #505

Closed saraburns1 closed 4 weeks ago

sarina commented 4 weeks ago

This isn't the right file for this content. A "Quickstart" (tutorial, in diataxis) should be a series of steps that shows you exactly what you need to do to complete a task. Mounting other directories is just confusing in the Quickstart. This belongs more in a How-To or Reference. And I actually think it probably belongs in the Tutor docs: https://docs.tutor.edly.io/index.html

What do you think?

sarina commented 4 weeks ago

It would be reasonable to link to Tutor docs somewhere within the quickstart

saraburns1 commented 4 weeks ago

This isn't the right file for this content. A "Quickstart" (tutorial, in diataxis) should be a series of steps that shows you exactly what you need to do to complete a task. Mounting other directories is just confusing in the Quickstart. This belongs more in a How-To or Reference. And I actually think it probably belongs in the Tutor docs: https://docs.tutor.edly.io/index.html

What do you think?

Makes sense! I'll close this for now