antoviaque
March 2, 2020, 10:22am
5
It’s currently lacking. But there is @regis who is leading an effort to improve that kind of documentation, as part of the Release working group:
I recently opened this PR, which is a work-in-progress: https://github.com/edx/edx-platform/pull/23183
My goal, and one we discussed as part of the build/test/release working group, is to create a reference manual for edx-platform, and later for all other Open edX services. This is groundwork that is a strong requirement before the working group can even start talking about crafting the named releases.
As you guessed, there is a lot of work involved
openedx:master ←
opened 05:27PM - 24 Feb 20 UTC
The aim of this PR is to generate a reference manual for edx-platform. This manu… al will eventually include all documentation that pertains to installation instructions, operational commands and settings. Changes to this manual should be documented as well so that we can track changes from one named release to the next.
I invite all interested parties to push their proposed changes to the btr-wg/reference-manual in the openedx-btr-wg organization: https://github.com/openedx-btr-wg/edx-platform/tree/btr-wg/reference-manual
Ping @nedbat @bderusha @jmaupetit @morenol @sambapete @BbrSofiane @jramnai
**Please don't force-push your changes!!!** Commits will be rebased once we have reached an acceptable status.
To generate the reference docs, run:
make reference-docs
EDIT: conversation around this PR should happen in the forums: https://discuss.openedx.org/t/looking-for-volunteers-to-build-a-reference-manual-for-edx-platform/1488
@andrey.kryachko @spurgeonbj Would one of you want to document this in the official doc?
[Edit] To know how, you can refer to @regis’ post linked above :
If you’d like to contribute, I’ll be more than happy to add you to the openedx-btr-wg organization on Github. You can then directly push your changes to the PR. Just send me a personal message with your Github nickname.
1 Like