search

openedx-unsupported / tutor-contrib-ralph

Tutor plugin for the Ralph LRS
Apache License 2.0
0 stars 1 forks source link

Bring repo up to maintainership standards #1

Closed bmtcril closed 1 year ago

bmtcril commented 1 year ago

We're still reviewing what this means for Tutor plugins, but at least a catalog-info.yaml file and docs.

Ian2012 commented 1 year ago

We were also with the doubt of the docs, and we think it's better to centralize everything in openedx-oars docs

bmtcril commented 1 year ago

I think that docs about configuration of this plugin and Ralph itself belong here, and things like the way OARS configures event-routing-backends to talk to Ralph belong in the tutor-contrib-oars docs. They'll both end up in docs.openedx.org and can cross link easily enough.

Ian2012 commented 1 year ago

Is it enough with a good readme or do we need a proper docs site hosted?

bmtcril commented 1 year ago

I think a good readme is a fine start. Mostly we will probably link out to Ralph or OARS docs from here as there isn't a lot of configuration.

Ian2012 commented 1 year ago

Do you have anything in mind that is missing in the readme to consider this as complete?

Currently, we have:

I see that we are missing the sentry integration, but I don't want to document it yet because all those settings probably will be set using a new strategy:

RALPH_SETTINGS:
    RALPH_SENTRY_DSN: "..."
    RALPH_EXECUTION_ENVIRONMENT: "..."
    RALPH_SENTRY_CLI_TRACES_SAMPLE_RATE: "..."
bmtcril commented 1 year ago

I think this is good for now, we'll likely want to put some more information as to what the different config variables actually do eventually but it's non-blocking so I'll close this out.