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

More realworld tutorials for new backoffice extensions #6483

Open
jemayn opened this issue Sep 30, 2024 · 2 comments
Open

More realworld tutorials for new backoffice extensions #6483

jemayn opened this issue Sep 30, 2024 · 2 comments

Comments

@jemayn
Copy link
Contributor

jemayn commented Sep 30, 2024

What type of issue is it? (Choose one - delete the others)

Missing documentation

Describe the issue

We have in the community package team been talking about the current documentation for building extensions in v14. And the agreement is that the new backoffice is pretty well-covered by reference documentation (and it seems the Backoffice team is still working on improving it).

What we feel is missing is more realworld tutorial style documentation like https://docs.umbraco.com/umbraco-cms/tutorials/creating-a-property-editor & https://docs.umbraco.com/umbraco-cms/tutorials/creating-a-custom-dashboard that takes people the whole way through new concepts and allows them to piece different parts together.

We've come up with a few examples of tutorials that could be an idea and what parts they would cover:

Tutorial ideas:

Reading data from a separate property editor

  • Set up fx a contentment data list picking a category
  • Set up a custom property editor that reads the selected categories from the first and allows selecting multiple products filtered to the selected categories

Covers:

  • Generate TS client to get product data from own API
  • Read data from another property editor (something which is very hard in 13 and lower)
  • Reusing the uui component for input fields
  • Opening modals and passing data back to the view

Dashboard that displays the audit log (or some other management api data stream)

  • Will list audit log entries in a listview
  • When selecting one it opens up in a big modal with all the relevant information

Covers

  • Pulling data from the management api
  • Routable modals for deeplinking
  • Rendering a listview uui component
  • Doing pagination on a listview uui component

We feel that these will supplement the current tutorials quite well, as well as introduce some new concepts that were not possible before in the AngularJS driven backoffice (reacting to the value of a separate property editor & deep linking modals).

@sofietoft
Copy link
Contributor

Those are some great thoughts and suggestions @jemayn ! 🙌

Is this something that the Package community team will explore further, or perhaps something that would be ideal for someone to pick up as a task during Hacktoberfest?

@jemayn
Copy link
Contributor Author

jemayn commented Oct 1, 2024

Thanks @sofietoft !

These are intended for ideas, and also to let others come with more ideas for good tutorials to bridge the gap between the different reference documentation articles.

People are very welcome to pick these ideas up for Hacktoberfest, but if noone does I will work on them during the Candid Contributions hackathon later this month 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants