umbraco / UmbracoDocs

The official Umbraco Documentation
https://docs.umbraco.com
MIT License
270 stars 784 forks source link

Cannot build a BlockEditor from the guide #5778

Open KristofferItide opened 10 months ago

KristofferItide commented 10 months ago

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

Wrong documentation

What article/section is this about?

https://docs.umbraco.com/umbraco-cms/extending/property-editors/build-a-block-editor

Describe the issue

When I try to implement a block editor with the documentation as reference, I get stucked. When I try to make the block editor in c#, VS says the base class and one of the attributes i deprecated. The Angular code is missing the context to where to put it. It could very cool with a overview in the end of the guide, showing the complete example, so it possible to get an overview. the impression of the guide is that it is half made.

alina-tincas commented 10 months ago

Hi @KristofferItide thank you for bringing this to our attention! I have tried the C# example as well on v9, v12 and v13 of CMS and get the following: image

Going through this article, it seems overall that this article is mostly for CMS v8 and therefore is not working for v9+ (as from v9+ Umbraco CMS is based on .NET instead of ASP.NET which CMS v8 and lower is based on). I will consult with my team what would be the best way to deal with this article. 🙏 For now I have updated the link for this sentence "Before reading this document we highly recommend that you familiarise yourself with the basics of developing a custom Property Editor for Umbraco" to the correct one (linking to creating a property editor) and added a hint note that this article is currently under revision as it might not work as intended 💪

Meanwhile, you are more than welcome to try the following guides to create a block list editor or block grid editor programmatically:

KristofferItide commented 10 months ago

Hi @alina-tincas Thanks for the reply. Yes it were also one of the error I got, I tried different possible solutions, but were not able to get it to work unfortunately. So an guide for v9 and forward would be very helpful.

Concerning the other to guides you have referenced, is a possibility for me. The hard part for me concerning the Block list, is that is it not mentioned where to put the code. There are examples but no reference for it. An example could be the last code snippet, the intro is: "After injecting [ContentService]and [ContentTypeService], we can do the following:" and after "When adding several items, it is important that each item added in contentData section has the corresponding Udi mentioned in the layout section as well - otherwise the item will not show.". For a good guide it is clearly mentioned for every codesnippet what it's context is. This is possible a more general remarks, but it is clearly a challenge here.

Tanks for your time!