Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure official plugin settings are documented #30

Open
Tracked by #123
kdmccormick opened this issue Jul 25, 2022 · 0 comments
Open
Tracked by #123

Ensure official plugin settings are documented #30

kdmccormick opened this issue Jul 25, 2022 · 0 comments
Labels
documentation Relates to documentation improvements tutor Requires a change to Tutor

Comments

@kdmccormick
Copy link
Member

kdmccormick commented Jul 25, 2022

Context

This is follow-up from openedx-unsupported/wg-developer-experience#6

Examples

The MFE plugin does a good job of describing its settings and how one can use them to customize the plugin: https://github.com/overhangio/tutor-mfe/

So does the Notes plugin: https://github.com/overhangio/tutor-notes

Acceptance Criteria

  1. Add a README section to plugin template repo inviting plugin authors to document the settings that they have defined
  2. For each official Tutor plugin, either:
  • Document any config settings defined by plugin in its README, or
  • Create an issue in the plugin repo for documenting those settings.
@kdmccormick kdmccormick added the documentation Relates to documentation improvements label Jun 2, 2023
@kdmccormick kdmccormick transferred this issue from openedx-unsupported/wg-developer-experience Mar 28, 2024
@kdmccormick kdmccormick added the tutor Requires a change to Tutor label Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to documentation improvements tutor Requires a change to Tutor
Projects
No open projects
Status: Refined
Development

No branches or pull requests

1 participant