You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* DOC-612 add single sourcing guidance
* fix typos
* add single-sourced content, like properties
* fix escape
* remove Cloud pages, edit beta features sections
* add that you can reference partials across repos
Copy file name to clipboardExpand all lines: meta-docs/CONTRIBUTING.adoc
+96-13Lines changed: 96 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,7 +72,7 @@ The Redpanda docs team uses GitHub issues to track, plan, and prioritize tasks.
72
72
73
73
You have the option to assign the issue to yourself or leave the assignee field blank. The Redpanda docs team triages all new issues and will allocate a writer if one isn't already assigned.
74
74
75
-
IMPORTANT: If you are a Redpanda employee, submit doc issues in the https://github.com/redpanda-data/documentation-private[`redpanda-data/documentation-private`] repo.
75
+
IMPORTANT: If you are a Redpanda employee, submit doc issues in https://redpandadata.atlassian.net/jira/software/c/projects/DOC/boards/65[Jira].
76
76
77
77
=== Contribute content
78
78
@@ -317,7 +317,7 @@ For example:
317
317
** xref:get-started:code-examples.adoc[Build a Sample Application]
318
318
....
319
319
320
-
<1> This page is an index. After the build, it will contains the titles and descriptions of all the topics underneath it.
320
+
<1> This page is an index. After the build, it will contain the titles and descriptions of all the topics underneath it.
321
321
322
322
To create an index page, give it a title and the `page-layout: index` attribute.
323
323
@@ -356,7 +356,7 @@ Antora calculates the URL for a source page's resource ID and generates redirect
356
356
357
357
NOTE: A resource ID assigned to a page-aliases attribute can be used in an xref. Therefore, if you delete, rename, or move a page, you don't need to update any references to it in your source files.
358
358
359
-
The content of the page-aliases attribute are used to create Netlify redirects in the `_redirects` file at build time.
359
+
The content of the page-aliases attribute is used to create Netlify redirects in the `_redirects` file at build time.
360
360
361
361
IMPORTANT: Make sure that links are relative to the current component version. Do not link to specific versions in page aliases.
362
362
@@ -374,11 +374,13 @@ asciidoc:
374
374
375
375
== Single-sourcing
376
376
377
-
Practice the DRY (Don't Repeat Yourself) principle by single-sourcing repeated content. Common examples of single-sourced content include prerequisites, contact info, and foundational steps of how-to guides.
377
+
Practice the DRY (don't repeat yourself) principle by single-sourcing repeated content. Common examples of single-sourced content include prerequisites, contact info, and foundational steps of how-to guides.
378
378
379
-
Antora supports single-sourcing Asciidoc files that are located in the `partials/` directory. For details about partials, see {url-antora-docs}/antora/latest/page/partials/[Partials] in the Antora docs.
379
+
For single-sourcing content in _different_ repositories, see <<single-sourcing-pages-across-repos, Single-sourcing across repos>>.
380
380
381
-
NOTE: You can include partials inside other partials.
381
+
For single-sourcing content in the _same_ repository, put shared content in the `partials/` directory. For details about partials, see {url-antora-docs}/antora/latest/page/partials/[Partials] in the Antora docs.
382
+
383
+
NOTE: You can include partials inside other partials. You can also reference partials when single-sourcing across repos.
382
384
383
385
Inside partials, you can conditionally render content depending on attributes that are available on the page that you include them in.
384
386
@@ -391,7 +393,7 @@ This will be rendered only if the pages you include the partial in do not have t
391
393
\endif::[]
392
394
393
395
\ifdef::env-kubernetes[]
394
-
This will be rendered only if the pages you include the partial in has the `env-kubernetes` attribute.
396
+
This will be rendered only if the pages you include the partial in have the `env-kubernetes` attribute.
395
397
\endif::[]
396
398
----
397
399
@@ -409,6 +411,91 @@ If you need to link to different pages in partials depending on the context of t
409
411
To learn more, see xref:{data-archiving-link}[Data Archiving]
410
412
----
411
413
414
+
=== Single-sourcing pages across repos
415
+
416
+
Redpanda documentation sits in different repositories for Self-Managed, Cloud, Redpanda Connect, and Labs. (See <<find-content, Find content>>.)
417
+
418
+
To single-source pages across repos:
419
+
420
+
. In the source repository, wrap the single-sourced page, after the title and aliases, with `// tag::single-source[]`.
421
+
. In the other repository, add the content with an `include` directive and the `single-source` tag. For example:
For more information about the include directive, see the https://docs.asciidoctor.org/asciidoc/latest/directives/include/[Asciidoc docs].
426
+
427
+
For an example of a page single-sourced from the `docs` repo into the `cloud-docs` repo, see https://docs.redpanda.com/current/get-started/partner-integration/ and https://docs.redpanda.com/redpanda-cloud/get-started/partner-integration/.
428
+
429
+
The file source in the `docs` repo looks like this:
430
+
[,asciidoc]
431
+
----
432
+
= Partner Integrations
433
+
:page-aliases: reference:partner-integration.adoc
434
+
// tag::single-source[]
435
+
:description: Learn about Redpanda integrations built and supported by our partners.
436
+
437
+
Learn about Redpanda integrations built and supported by our partners.
438
+
439
+
[.no-clip]
440
+
[cols="1a,2a,1a"]
441
+
|===
442
+
|*Partner* |*Description* |*More information*
443
+
...
444
+
445
+
// end::single-source[]
446
+
----
447
+
448
+
The shared version of this page in the `cloud-docs` repo looks like this:
All doc repositories use a single navigation file for the nav tree, which is defined in the `nav.adoc` file of the `ROOT` module.
@@ -417,13 +504,9 @@ To update the nav tree, edit the `nav.adoc` file.
417
504
418
505
For more information about navigation files, see the {url-antora-docs}/antora/latest/navigation/include-lists/[Antora docs].
419
506
420
-
== Cloud pages
421
-
422
-
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.
423
-
424
-
=== Cloud beta feature
507
+
=== beta features
425
508
426
-
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`.
509
+
In `cloud-docs`, and occasionally in other repos, individual features can exist in beta status. If that's the case, add the attribute `page-beta:true` to your page header.
0 commit comments