From 11471f94d36693aa4496a6a15147acbd15802ea8 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Thu, 16 Nov 2023 13:42:42 -0300 Subject: [PATCH 1/3] add cloud beta usage --- meta-docs/CONTRIBUTING.adoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/meta-docs/CONTRIBUTING.adoc b/meta-docs/CONTRIBUTING.adoc index fd1b384..68d3a63 100644 --- a/meta-docs/CONTRIBUTING.adoc +++ b/meta-docs/CONTRIBUTING.adoc @@ -392,6 +392,18 @@ To update the nav tree, edit the `nav.adoc` file. For more information about navigation files, see the {url-antora-docs}/antora/latest/navigation/include-lists/[Antora docs]. +== Cloud pages + +Cloud pages should be tagged accordingly. If you create a cloud page make sure to add the attribute `page-cloud:true` after `title:` and `description:`. + +=== Cloud beta feature + +Cloud has a different flavor of beta, where some specific features can be marked as beta. If that's the case, add the attribute `page-beta:true` to your page, after `page-cloud:true`. + +== Feature Flag + +If a feature is marked as feature flag, please include the partial admonition that identifies it. Use `include::shared:partial$feature-flag.adoc[]` as the first information on your page. + == Style guide For rules and recommendations as well as help with Asciidoc syntax, see the link:./STYLE-GUIDE.adoc[Redpanda docs style guide]. From dc59c5292c1f2edc3e5c30790e74c2949f3d1b60 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Thu, 16 Nov 2023 14:04:03 -0300 Subject: [PATCH 2/3] Update meta-docs/CONTRIBUTING.adoc Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> --- meta-docs/CONTRIBUTING.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meta-docs/CONTRIBUTING.adoc b/meta-docs/CONTRIBUTING.adoc index 68d3a63..fc9257a 100644 --- a/meta-docs/CONTRIBUTING.adoc +++ b/meta-docs/CONTRIBUTING.adoc @@ -394,7 +394,7 @@ For more information about navigation files, see the {url-antora-docs}/antora/la == Cloud pages -Cloud pages should be tagged accordingly. If you create a cloud page make sure to add the attribute `page-cloud:true` after `title:` and `description:`. +Redpanda Cloud pages should be tagged accordingly. If you create a Redpanda Cloud page make sure to add the attribute `page-cloud:true` to the top of the file under the title. === Cloud beta feature From 9d266716a82635f599a79ae63112dcea64167b65 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Thu, 16 Nov 2023 14:04:19 -0300 Subject: [PATCH 3/3] Update meta-docs/CONTRIBUTING.adoc Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> --- meta-docs/CONTRIBUTING.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meta-docs/CONTRIBUTING.adoc b/meta-docs/CONTRIBUTING.adoc index fc9257a..bc2f5ba 100644 --- a/meta-docs/CONTRIBUTING.adoc +++ b/meta-docs/CONTRIBUTING.adoc @@ -402,7 +402,7 @@ Cloud has a different flavor of beta, where some specific features can be marked == Feature Flag -If a feature is marked as feature flag, please include the partial admonition that identifies it. Use `include::shared:partial$feature-flag.adoc[]` as the first information on your page. +If a feature is marked as a feature flag, please include the partial admonition that identifies it. To include the admonition, add `include::shared:partial$feature-flag.adoc[]` to the top of the page after the title and any attributes. == Style guide