Skip to content

Conversation

@abjerner
Copy link
Contributor

Description

Every time I end up at the Global Settings page, I feel like each section on the page misses a bit of context. You can see the description about a given option, but you can't see the actual key unless you scroll back up to the top of the page. Also if you enter the page searching for a specific key, you can only find it in the big JSON example.

With this commit, I've added an extra line for each option stating the name of the associated key, and for most of the options, also specified a default value. I feel that this improving the descriptions for the various options. And keep scrolling frantically up and down to minimum.

There are a few options where I'm unsure about what to enter, so I've skipped these. Some of them I've skipped adding the key entirely, why others I've skipped the default key. E.g. if this is mentioned in the text already. Or if the description says one, but the option via IOptions<GlobalSettings> is really an empty string by default.

I hope this makes sense 😉

Type of suggestion

  • Typo/grammar fix
  • Updated outdated content
  • New content
  • Updates related to a new version
  • Other

Product & version (if relevant)

Deadline (if relevant)

No deadline

@sofietoft
Copy link
Contributor

Thanks @abjerner !
This is a great addition to the article 👏 Anything to make these articles more readable! 😁

I do have one suggestion though after looking at the preview:
image

Could we try adding the default value to a separate line?
So, something like:

Key: UmbracoMediaPath
Default: ~/media

What do you think? 🤔

@abjerner
Copy link
Contributor Author

Yeah, I can fix that 👍

I had debated with my self what would be the best format, so I had also considered going on a second line.

I had also thought about adding the type of the value - e.g. string or bool. Would this make sense as well?

@sofietoft
Copy link
Contributor

Yeah! Adding the value type could be excellent 🙌

Then perhaps we do:

Key: UmbracoMediaPath
Type: string (default: ~/media)

Because, I don't think we want to go for 3 lines, right? 😅

Added value type as well
@abjerner
Copy link
Contributor Author

@sofietoft I agree. Should be updated now 😉

Copy link
Contributor

@sofietoft sofietoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @abjerner !

Let's go with it 😁👏🏻
Thanks again for suggesting and implementing this change!

@sofietoft sofietoft merged commit 6ab9c9b into umbraco:main Nov 1, 2024
5 checks passed
sofietoft added a commit that referenced this pull request Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants