In v13 there is no startup.cs file #5952
Conversation
I think this is how you do it in v13 and project.cs, but copied it from the latest branch of the core repo
There was a problem hiding this comment.
Hi @marcemarc thank you for this PR!
It is correct that from v13 there is no startup.cs, however these steps are specifically only for v11 and below. You can find more information about why this was added here: #5796
In this case I suggest that we change the hint style above these steps to "warning" so it is more obvious?
| @@ -24,20 +24,17 @@ Video tutorial | |||
| This step is only applicable for Umbraco projects started on version 11 or below. | |||
There was a problem hiding this comment.
the steps below are only for projects below v11 as this hint states. Perhaps in this case it might be better to change the hint style="info" to hint style="warning" to make this more obvious?
There was a problem hiding this comment.
Missed that! I was just sparked by this forum post
so was thinking ahh, where have they seen the advice to update startup.cs... so I was looking specifically for the sample on the V13 version of the documentation, rather than reading it linearly... so I missed the 'hint'
I think we used to struggle with the balance of this with V6/v7/v8 docs - you want 'only' the information for the version that the person has selected in the docs, but sometimes there is very little change between the articles and also what about people who aren't using the latest version...
... with developer and documentation - often people are quickly searching/skimming a page for an answer, their time is precious, it's different to sitting down to read - the code sample is 'the gold' it's where attention is drawn to, the developer brain understands the code better than the description (well not all devs, we all consume and learn differently)
Anyway, I think that is the trap the person in the forum fell into and I followed...
But what do we do for 'V12 and below users' who are accidentally visiting the V13 page documentation? when they haven't adopted V13 yet? and for how long do we support that journey as 'the default' given V13 is the LTS.
I think you could put the additional legacy information inside an accordion? now that we can do that in the docs??
so you'd have
Register the Content Delivery API Dependencies
For V13, and above the Content Delivery API Dependencies are automatically registered via .AddDeliveryApi() in the solution's project.cs File
For V12 and Below [v]
(this is the bit inside the accordion and describes the steps for registering dependencies in startup.cs)
This way nobody is accidentally drawn to the code sample, but you are still supporting the swathes of people who haven't adopted V13 yet - also when you come to edit this page for V17 LTS, you can think ok, we can remove this accordion now, and it's much easier to see what needs to be removed.
There was a problem hiding this comment.
I think that is a really good idea! So below this text "Umbraco projects started on version 11 or below also need to opt-in through code by registering the delivery API dependencies. Below you will find a description of how to do this." add accordion with the steps under "Register the Content Delivery API dependencies for v12 or below". 👍
Would you be up for making this change or would you prefer me to do it asap? 😊
There was a problem hiding this comment.
HI Alina - I don't know how to do the magic accordion markup!!!
feel free to tweak and I can observe, or I may get chance over the weekend to have a look.
regards
Marc
There was a problem hiding this comment.
Hey Marc, you can find an example here: https://github.com/umbraco/UmbracoDocs/blob/main/14/umbraco-cms/tutorials/creating-a-property-editor/adding-configuration-to-a-property-editor.md?plain=1. Where it is written “see the entire file”
Shortly it needs the details and summary tags as per the gitbook docs (gitbook being the platform we use for our docs) https://docs.gitbook.com/content-editor/blocks/expandable
You can give it a try if you have some time and then I can review and help along the way 😊
There was a problem hiding this comment.
@alina-tincas done! (I think) hopefully correctly...
firstly I moved any mention of this step to be below the video, I figure for most people moving forwards, the topic is introduced the video is there...
... for people looking at the exact steps, will then see the accordion
I've tweaked the order of the text, as we read from left to right, so the very first bit of the accordion title is 'For Version 12 and below ONLY' - this makes it easier for the reader to skip this entirely, whereas if they are skimming they may not get to the end of the bit about it being V12 only, before expanding the accordion...
I'm not sure if I'm meant to be able to see the result somewhere! but hopefully this gives you something to work with!
regards
marc
Hide the V12 and below configuration in an accordion
There was a problem hiding this comment.
Hi @marcemarc thank you for making the changes! I have just 2 suggestions left, can you let me know what you think of them? 😊
Co-authored-by: Alina-Magdalena Tincas <[email protected]>
Co-authored-by: Alina-Magdalena Tincas <[email protected]>
missing a g
|
@alina-tincas done I think!!!!! |
|
It is done indeed 😁 Thank you for making the necessary changes and for contributing #h5YR Merging this in 💪 |
|
no #h5YR ! |
I think this is how you do it in v13 and project.cs, but copied it from the latest branch of the core repo
Description
What did you add/update/change?
Type of suggestion
Product & version (if relevant)
Deadline (if relevant)
When should the content be published?