Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Documentation has 4 types of tags: draft, new, updated, outdatedcaution.

Life cycle of tagsImage RemovedLife cycle of tagsImage Added

Syntax:

---
title: 
note: 
tags:
- (place the tag name written in lowercase letters here)
--- 

...

  • The item of the page, for example a component, is currently in its initial development.
  • Information in an article, for example a pattern, is being reworked and thereby subject to change.
  • A page in the wiki is being created, and the published version is not the desired final state.
  • Information on a page is not verified.

A note at the beginning of an article can explain what the development in question is referring to.

...

  • Addition - New information is added to the page. For example, a component has a new feature.
  • Deletion - Outdated or wrong information gets removed from a page.
  • Alteration - Information on the page is fundamentally changed. For example, a pattern is restructured. This does not include purely editorial changes.

...

Caution

If a page contains critical content, it receives the "outdatedcaution"-tag. This applies to both the text and the information behind it. Examples for critical information:

  • A page shows outdated information that might mislead the user.
  • The subject of the page, for example a component, is not working as designed /has a bugand needs to be changed.
  • Information on a page is not verified.
  • Multiple users have reported problems with this page. For example, the wording of the documentation is unclear.

A note at the start of the page might give further information on the critical content.

...

[!NOTE] This article is about the Boardlet Pattern. For more information about the boardlet component in the App Composer, please visit this page.

Warning

The "outdatedcaution" or "draft" tags might need further explanation. This explanation is placed in an alert at the beginning of the article. This alert describes

...