Add article descriptions

[sofietoft]

Hacktoberfest 2024

The tasks in this issue in intended for Hacktoberfest contributions.
Hacktoberfest starts on October 1st.

All articles need to have a proper description

A description is a one-liner that will be displayed directly below the titles of the article.
This description also acts as the meta description used for SEO.

A good description will

• Describe what the article covers
• Be no longer than 156 characters (1 - max 2 - short sentences)
• Include keywords relevant to the content of the article

How to add a description

Adding a description requires adding some YAML to the top of the article.
Use the example below as a reference:

---
description: Health Checks are used to determine the state of your Umbraco project. Learn more about each of them in this section.
---

Where to start

Many articles in the Umbraco Documentation are missing a description, but here's a list to help you get started.

• Health Check: ClickJacking Protection
• Health check: CSP
• Health Check: Content/MIME sniffing protection
• Health Check: Debug Compilation Mode
• Cookies
• Replacing the basic username/password check
• Locking of Users and password reset
• Umbraco Security Hardening
• Language Variation

Other places to look for missing descriptions:

• Umbraco Cloud Project Settings docs
• Umbraco Forms Developer docs
• Umbraco Forms Editor docs

[SamTimalsina-ST]

@sofietoft Has this been done? I would love to contribute

[sofietoft]

@sofietoft Has this been done? I would love to contribute

Hi! How wonderful to hear that you want to contribute!! 🙌
Only a couple, I think 4, from the list, have already been fixed, so there is still lots more to do 😁

If you could wait juuuuust a few more days, I'd suggest you join Hacktoberfest, which starts on October 1st.
It's this month-long celebration of open source, where you can get recognized and also (I believe) get a Tshirt for submitting a number of PR to open source products 😎

I'll add a little note to the Issue, to let people know this is intended for Hacktoberfest contributions!

I look forward to reviewing your contributions 😄

[SamTimalsina-ST]

Hi! Thanks for the suggestion!😊, I have joined Hacktoberfest and im excited 🎉 I’ll definitely wait and get involved when it starts

[Iqmaa]

Hi @sofietoft , I've registered for Hacktoberfest.
I'd really like to contribute to this.

[sofietoft]

That's great to hear @Iqmaa ! 😄
Please let me know in a comment if you're picking up some of the articles in the list, otherwise, feel free to make the PRs and I'll make sure we get them reviewed.

You can find contribution docs here: https://docs.umbraco.com/contributing/documentation/getting-started

Let me know if something isn't clear!
Happy writing 💪

[Iqmaa]

Thanks @sofietoft !
I'll like to take the articles 'Locking of users and password reset', 'Umbraco Security Hardening' and 'Cookies'

[Iqmaa]

Hi @sofietoft , I've sent in a pull request.
Please review it when you can.

[ovindu-a]

Hi @sofietoft, can I work on this as well?

[sofietoft]

Hi @sofietoft, can I work on this as well?

For sure @ovindu-a ! 💪
Let me know which articles from the list (not many left though 😅 ), or identify missing descriptions in one of the sections I've mentioned.

[ovindu-a]

@sofietoft I must add the descriptions for the documentation on v14 right?

[sofietoft]

Yes, please do that @ovindu-a !
You're welcome to add the description to 10 and 13 as well - but not a requirement!

[ovindu-a]

I have made a PR @sofietoft. Will add them for 10 and 13 once it gets approved.