-
Notifications
You must be signed in to change notification settings - Fork 806
"Extension Types" documentation updates #7302
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks very good to me @bszyman - thanks very much for preparing it.
I added a few minor points in line you could look at.
And then just considered what may be missing and important (I think you are right to try to avoid overwhelming). But perhaps the following might be good to add:
- Property level UI permissions: https://docs.umbraco.com/umbraco-cms/customizing/property-level-ui-permissions
- Tip-tap extensions
- UFM components
Then finally perhaps it's worth referring the reader to the backoffice itself, so they can see the full set under Settings > Extension Insights?
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Outdated
Show resolved
Hide resolved
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Outdated
Show resolved
Hide resolved
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Outdated
Show resolved
Hide resolved
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Outdated
Show resolved
Hide resolved
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Outdated
Show resolved
Hide resolved
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Outdated
Show resolved
Hide resolved
… and ufm components to the listing. Added text and imagery about the Extension Insights browser in the backoffice.
… and ufm components to the listing. Added text and imagery about the Extension Insights browser in the backoffice.
…on-types-pr # Conflicts: # 16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Hey @AndyButland - Thanks for your feedback! I incorporated all of your suggestions, and made a few other tweaks and improvements. Could you have another look when you have a chance? Thank you! |
9c40e29
to
233af9f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @bszyman, looks very good to me now. I'd say this is ready for docs team review now @sofietoft.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great stuff @bszyman ! 🙏
I've made a couple of suggestion throughout the article - mostly around some long sentences.
Also, here are a few general comments:
When adding these lists by copying the list in the navigation menu, they should be ordered the same way. I see you've ordered the items alphabetically in the article, but it's not ordered like that in the navigation.
It would be great if you could update the SUMMARY file, so that both lists are ordered in the same way.
Also, are items added to the list that are not in the navigation? 🤔
Looks like you're adding line breaks even when a sentence isn't done. There's no need for this 🙏
It also looks like the vale linter doesn't pick up all sentences that are too long, when there are line breaks in between 😅
Don't worry about changing it for this PR since it's already gone through multiple reviews, but something to keep in mind for the next ones.
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Outdated
Show resolved
Hide resolved
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Outdated
Show resolved
Hide resolved
16/umbraco-cms/customizing/extending-overview/extension-types/README.md
Outdated
Show resolved
Hide resolved
Sorry, that was an editor setting. I went through and fixed it anyway, while incorporating your suggestions.
DONE! :)
Yes, at the suggestion of Andy. I agree that it's not consistent and potentially confusing, however I also agree with him that it'd be nice to have them listed out/linked to. I'm almost thinking that these could be broken out into another section maybe |
…ies, clarified descriptions, and improved section ordering in the summary.
2573505
to
66ec5c7
Compare
Thanks for applying the suggestions @bszyman . I think it makes sense to put the articles not part of the section, at the bottom of the list. Hope you agree. |
📋 Description
Updated this document to list out all the general extension types listed underneath it in the documentation site's navigation hierarchy. Referenced against the Extension Insights section in the Umbraco backoffice.
The Extension Insights menu in the Umbraco backoffice lists almost 70 extension types, and listing those all out seems excessive and like it might make it difficult/less approachable for new users to evaluate and wayfind deeper into topics elsewhere in the documentation. The existing selection of extension types in the navigation bar/navigation hierarchy on the documentation site seemed to make more sense.
📎 Related Issues (if applicable)
N/A
✅ Contributor Checklist
I've followed the Umbraco Documentation Style Guide and can confirm that:
Product & Version (if relevant)
v16
Deadline (if relevant)
N/A
📚 Helpful Resources