JSON schema for packages in v11

[ronaldbarendse]

What type of issue is it?

Missing documentation

What article/section is this about?

Extending - Packages - JSON schema for packages

Describe the issue

PR umbraco/Umbraco-CMS#13427 added a feature to Umbraco 11 that allows packages to include their own appsettings.json JSON schema (providing validation and auto-completion), but the documentation for this isn't yet added after release. This is only relevant for packages that store custom settings in this file and requires packages to create/generate their own JSON schema first, making it a more advanced feature (that might not be required/used that often).

To make generating the JSON schema easier, I've converted the internal tool we use for this into a .NET tool in PR umbraco/Umbraco-CMS#13560, but that's not merged yet (although it can possibly be shipped separately, similar to the related Umbraco.JsonSchema.Extensions project).

I'm creating this issue to ensure we don't forget adding documentation for this feature and discuss where it needs to be added (since we're restructuring the packages documentation a bit with the introduction of the DXP section/space).

[sofietoft]

Thanks for creating this @ronaldbarendse ! 💪

Just to make sure I understand - this is something that you will work on, right?
Or is this something that should be added as soon as possible, and you are asking my team to do it? 🤔

[ronaldbarendse]

I'll make sure the initial documentation gets written, since it's quite technical and there's also some gotchas to include as well (that aren't even mentioned in the linked PRs). I've mainly created this issue to track progress, let you know it's missing and also have somewhere to link to if you get questions about it.

[jonat123]

@ronaldbarendse Hey!

I was wondering what the status is for this issue?

Are you still planning on creating the initial docs?

[ronaldbarendse]

I'll have to follow up on PR umbraco/Umbraco-CMS#13560 first... This hasn't been prioritized though, as the feature was mainly added to remove the dependency on the Forms and Deploy JSON schemas within the CMS. It's still relevant for package developers though...