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

[E2] Provide information on how to create an API plugin #202

Open
qmatteoq opened this issue Aug 14, 2024 · 2 comments
Open

[E2] Provide information on how to create an API plugin #202

qmatteoq opened this issue Aug 14, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@qmatteoq
Copy link
Contributor

I appreciate that the lab gives you a starting point so that you don't have to deal with lot of boilerplate JSON but, as someone who is approaching API plugins for the first time, I find it a bit confusing because, once I have completed the lab, I have no idea on how to create a new one on my own.

I think it would be beneficial to:

  • Keep the copy & paste approach but, in the intro of the exercise, add a paragraph that explains how you have created the plugin definition

OR

  • Let the user create the plugin given the API URL and then replace the generated content with the one provided in the starting project.

The second one would be more effective, but I understand it's more challenging because the API URL isn't fixed and, in the plugin definition, it's defined with a variable.

@qmatteoq
Copy link
Contributor Author

To reinforce my comment, Teams Toolkit pre-release just added the option to create API plugins and declarative Copilots: https://github.com/OfficeDev/teams-toolkit/blob/dev/packages/vscode-extension/PRERELEASE.md

@BobGerman
Copy link
Collaborator

Great input!
We have unfortunately found that Teams Toolkit changes their scaffolded code without notice; in the past this has broken labs that begin with creating a new project and then has students modifying the code.
That said I think we can at least take your first suggestion. Thanks!

@BobGerman BobGerman self-assigned this Aug 23, 2024
@BobGerman BobGerman added the documentation Improvements or additions to documentation label Aug 23, 2024
@rabwill rabwill self-assigned this Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants