From d4f31d2ad712160b92f48f993a5ac4e4dd7b29d6 Mon Sep 17 00:00:00 2001 From: as-op Date: Tue, 25 Jun 2024 12:49:31 +0200 Subject: [PATCH 1/3] feat(docs): document support for github markdown alerts --- .../documentation-style-guide/README.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/development/contribution-documentation/documentation-style-guide/README.md b/docs/development/contribution-documentation/documentation-style-guide/README.md index 3f804689d083..43060779c4e1 100644 --- a/docs/development/contribution-documentation/documentation-style-guide/README.md +++ b/docs/development/contribution-documentation/documentation-style-guide/README.md @@ -383,3 +383,49 @@ Use alert boxes to call attention to information. The alert boxes in the OpenPro ```markdown > **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../enterprise-guide/enterprise-cloud-guide/#create-a-new-account). ``` + +> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../enterprise-guide/enterprise-cloud-guide/#create-a-new-account). + +## Alerts + +Alerts are a Markdown extension by Github based on the blockquote syntax that you can use to emphasize critical information. + +```markdown +> [!NOTE] +> Useful information that users should know, even when skimming content. + + +> [!TIP] +> Helpful advice for doing things better or more easily. + + +> [!IMPORTANT] +> Key information users need to know to achieve their goal. + + +> [!WARNING] +> Urgent info that needs immediate user attention to avoid problems. + + +> [!CAUTION] +> Advises about risks or negative outcomes of certain actions. +``` + +> [!NOTE] +> Useful information that users should know, even when skimming content. + + +> [!TIP] +> Helpful advice for doing things better or more easily. + + +> [!IMPORTANT] +> Key information users need to know to achieve their goal. + + +> [!WARNING] +> Urgent info that needs immediate user attention to avoid problems. + + +> [!CAUTION] +> Advises about risks or negative outcomes of certain actions. From 3e1e08597080d702d0d9bf97043322a3cbc0f644 Mon Sep 17 00:00:00 2001 From: as-op Date: Tue, 25 Jun 2024 12:52:54 +0200 Subject: [PATCH 2/3] fix link in example --- .../documentation-style-guide/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/development/contribution-documentation/documentation-style-guide/README.md b/docs/development/contribution-documentation/documentation-style-guide/README.md index 43060779c4e1..1c73a7cd6ea9 100644 --- a/docs/development/contribution-documentation/documentation-style-guide/README.md +++ b/docs/development/contribution-documentation/documentation-style-guide/README.md @@ -381,10 +381,10 @@ At the moment it is not possible for external contributors to upload videos to t Use alert boxes to call attention to information. The alert boxes in the OpenProject documentation have a specific format. Please use the following to be consistent: ```markdown -> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../enterprise-guide/enterprise-cloud-guide/#create-a-new-account). +> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../../enterprise-guide/enterprise-cloud-guide/#create-a-new-account). ``` -> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../enterprise-guide/enterprise-cloud-guide/#create-a-new-account). +> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../../enterprise-guide/enterprise-cloud-guide/#create-a-new-account). ## Alerts From 7759990236ca9edab617dd7ac1f1879b38ea511d Mon Sep 17 00:00:00 2001 From: as-op Date: Tue, 25 Jun 2024 12:55:16 +0200 Subject: [PATCH 3/3] fix link in example --- .../documentation-style-guide/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/development/contribution-documentation/documentation-style-guide/README.md b/docs/development/contribution-documentation/documentation-style-guide/README.md index 1c73a7cd6ea9..66b075db7d37 100644 --- a/docs/development/contribution-documentation/documentation-style-guide/README.md +++ b/docs/development/contribution-documentation/documentation-style-guide/README.md @@ -381,10 +381,10 @@ At the moment it is not possible for external contributors to upload videos to t Use alert boxes to call attention to information. The alert boxes in the OpenProject documentation have a specific format. Please use the following to be consistent: ```markdown -> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../../enterprise-guide/enterprise-cloud-guide/#create-a-new-account). +> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../../enterprise-guide/enterprise-cloud-guide/create-cloud-trial/). ``` -> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../../enterprise-guide/enterprise-cloud-guide/#create-a-new-account). +> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../../enterprise-guide/enterprise-cloud-guide/create-cloud-trial/). ## Alerts