Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Document anatomy of a plugin #33

Closed
kdmccormick opened this issue Jan 28, 2022 · 1 comment
Closed

Document anatomy of a plugin #33

kdmccormick opened this issue Jan 28, 2022 · 1 comment
Labels
wontfix This will not be worked on

Comments

@kdmccormick
Copy link
Collaborator

kdmccormick commented Jan 28, 2022

Original Context

This issue is similar to https://github.com/overhangio/2u-tutor-adoption/issues/29, except it's about the structure of the source templates instead of the rendered Tutor root.

There are some things I found confusing when working on a plugin. Once they became clear, plugin development got a lot easier. If I didn't have other working plugins to use as reference, then I'm not sure I would have been able to figure these things out without reaching out for help:

  • Only templates under $TEMPLATE_ROOT/myplugin are rendered. The docs do say this but I wonder why it has to be the case.
  • Within a plugin's template dir, only build, hooks, and apps are rendered. Other files are excluded. The docs don't aren't clear on this.
  • It is not clear on what should go in apps, although I infer it is for "any file you want to include in your docker image".

Could we clarify these, either via documentation or simplification of the plugin API?

New Context

@regisb will be proposing a Plugin API v1 as part of #32.

Acceptance

Ensure there are docs explaining the structure of a version-1 Tutor plugin. Should be part of the plugin developer guide.

@kdmccormick kdmccormick changed the title As a plugin developer, I want it to be clear how to structure my plugin Document plugin structure Feb 9, 2022
@kdmccormick kdmccormick changed the title Document plugin structure Document the anatomy of a Tutor plugin Feb 9, 2022
@kdmccormick kdmccormick moved this from Ungroomed to Groomed in Tutor DevEnv Adoption (OLD BOARD) Feb 9, 2022
@kdmccormick kdmccormick changed the title Document the anatomy of a Tutor plugin Plugin Dev Guide: Anatomy of a plugin Feb 16, 2022
@kdmccormick kdmccormick changed the title Plugin Dev Guide: Anatomy of a plugin Document anatomy of a plugin Feb 16, 2022
@kdmccormick kdmccormick moved this from 📥 New to 📋 Refined in Developer Experience Working Group Nov 18, 2022
@kdmccormick
Copy link
Collaborator Author

This is obsoleted by #32. There is still documentation work to do for plugins, but this issue doesn't capture what needs to be done.

Repository owner moved this from 📋 Refined to 🚀 Closed in Developer Experience Working Group Nov 18, 2022
Repository owner moved this from 📋 To Do to 🚀 Closed in Tutor DevEnv Adoption Nov 18, 2022
@kdmccormick kdmccormick added the wontfix This will not be worked on label Nov 18, 2022
@kdmccormick kdmccormick closed this as not planned Won't fix, can't repro, duplicate, stale Feb 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant