Skip to content

Commit 4daccc9

Browse files
authored
Fix #28: Improved "Building Deliverables" with examples (#81)
* fix#28:improved building deliverables with examples Signed-off-by: sushant-suse <[email protected]> * fix#28:added changelog file Signed-off-by: sushant-suse <[email protected]> --------- Signed-off-by: sushant-suse <[email protected]>
1 parent 3f85c52 commit 4daccc9

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

changelog.d/81.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add new examples to improves the documentation for the docbuild build command.

docs/source/user/build.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,13 @@ The fields in the doctype have the following meanings:
3737

3838
Some common examples of doctypes are:
3939

40-
* ``//en-us``: Matches all supported deliverables in English.
41-
* ``sles/*/en-us``: Matches all SLES deliverables in English, regardless of the docset or lifecycle.
40+
* ``sles/15-SP6/en-us``: Matches the English deliverables for SLES 15-SP6, regardless of the lifecycle.
41+
* ``*/*/de-de``: Matches all deliverables in German, regardless of the product, docset, or lifecycle.
42+
* ``//en-us``: Matches all deliverables in English, regardless of product, docset, or lifecycle. This is a shorter version of ``*/*/en-us``.
43+
* ``sles//en-us``: Matches all English SLES deliverables, regardless of the docset or lifecycle.
4244
* ``sle-ha//@unsupported/en-us,de-de``: Matches all SLE-HA deliverables in English and German that are in the unsupported lifecycle, regardless of the docset.
43-
* ``"*/@beta,supported/de-de"``: Matches all SLES deliverables in German that are in the beta or supported lifecycle, regardless of the product.
45+
* ``*/@beta,supported/de-de``: Matches all SLES deliverables in German that are in the beta or supported lifecycle, regardless of the product.
46+
* ``//``: Matches all deliverables in all languages, regardless of the product, docset, or lifecycle. This is the simplest doctype and matches everything.
4447

4548

4649
Minimal set of doctypes
@@ -54,4 +57,4 @@ The command tries to find overlaps in the specified doctypes and only builds the
5457
5558
[1] sles/*/en-us + sles/15-SP6/en-us => sles/*/en-us
5659
[2] sles/*/en-us + sles/15-SP6/de-de => sles/*/en-us,sles/15-SP6/de-de
57-
[3] sles/15-SP6/en-us + sles/15-SP6/de-de => sles/15-SP6/en-us,de-de
60+
[3] sles/15-SP6/en-us + sles/15-SP6/de-de => sles/15-SP6/en-us,de-de

0 commit comments

Comments
 (0)