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
@@ -1399,23 +1399,16 @@ The path should be as specific as possible because we skip rebuilding books if
1399
1399
changes to the referenced repository don't change the referenced path.
1400
1400
1401
1401
[[changes]]
1402
-
== Additionsand deprecations
1402
+
== Additions, deprecations, and discontinuations
1403
1403
1404
-
Documentation is built for various branches, eg `0.90`,
1405
-
`1.00`, `master`. However, we release versions
1406
-
`0.90.0`, `0.90.1`, etc, which are all based on the
1407
-
`0.90` branch.
1404
+
When adding, deprecating, or discontinuing functionality, you can mark the change as
1405
+
_coming_, _generally available_ (formerly _added_), _deprecated_, or _discontinued_.
1408
1406
1409
-
When adding new functionality to a branch, or deprecating
1410
-
existing functionality, you can mark the change as
1411
-
_added_, _coming_ or _deprecated_. Use `coming` when the addition is
1412
-
in an as yet unreleased version of the current branch, and `added` when
1413
-
the functionality is already released.
1414
-
1415
-
The `update_versions.pl` script can be used to change `coming` notices
1416
-
to `added` notices when doing a new release, and can also be used
1417
-
to remove `added`, `coming` and `deprecated` notices completely.
1407
+
Use `coming` when the addition is in an as yet unreleased version of the current branch.
1408
+
Use `generally_available` when the functionality is released and no longer in a beta, dev, or preview state.
1418
1409
1410
+
For Elastic Serverless and Elasticsearch Service content, there currently isn't a public identifier for individual releases.
1411
+
In other contexts, you can qualify the addition, deprecation, or discontinuation with a specific version number.
1419
1412
1420
1413
=== Inline notifications
1421
1414
@@ -1425,33 +1418,20 @@ the addition or deprecation of individual parameters.
1425
1418
[source,asciidoc]
1426
1419
----------------------------------
1427
1420
[horizontal]
1428
-
`foo.bar`:: Does XYZ. added:[0.90.4]
1429
-
`foo.bar`:: Does XYZ. coming:[0.90.4]
1430
-
`foo.baz`:: Does XYZ. deprecated:[0.90.4]
1421
+
`foo.bar`:: Does XYZ. ga_stack:[0.90.4]
1422
+
`foo.bar`:: Does XYZ. coming:[0.90.4] coming_serverless:[] coming_ess:[]
1423
+
`foo.baz`:: Does XYZ. deprecated:[0.90.4] deprecated_serverless:[] deprecated_ess:[]
1431
1424
----------------------------------
1432
1425
1433
-
[horizontal]
1434
-
`foo.bar`:: Does XYZ. added:[0.90.4]
1435
-
`foo.bar`:: Does XYZ. coming:[0.90.4]
1436
-
`foo.baz`:: Does XYZ. deprecated:[0.90.4]
1437
-
1438
-
You can also include details about additional
1439
-
notes in the notifications which show up when the
1440
-
user hovers over it:
1426
+
Some annotations also enable you add custom notes that show up when the user hovers over it:
1441
1427
1442
1428
[source,asciidoc]
1443
1429
----------------------------------
1444
1430
[horizontal]
1445
-
`foo.bar`:: Does XYZ. added:[0.90.4,Replaces `foo.baz`]
1446
1431
`foo.bar`:: Does XYZ. coming:[0.90.4,Replaces `foo.baz`]
1447
1432
`foo.baz`:: Does XYZ. deprecated:[0.90.4,Replaced by `foo.bar`]
1448
1433
----------------------------------
1449
1434
1450
-
[horizontal]
1451
-
`foo.bar`:: Does XYZ. added:[0.90.4,Replaces `foo.baz`]
1452
-
`foo.bar`:: Does XYZ. coming:[0.90.4,Replaces `foo.baz`]
1453
-
`foo.baz`:: Does XYZ. deprecated:[0.90.4,Replaced by `foo.bar`]
1454
-
1455
1435
[NOTE]
1456
1436
====
1457
1437
If the details include a comma, you must use quotation marks. For example:
@@ -1463,98 +1443,48 @@ deprecated::[1.1.0,"Span started automatically by <<apm-start-span,apm.startSpan
1463
1443
1464
1444
=== Section notifications
1465
1445
1466
-
Use section notifications to mark an entire chapter or
1467
-
section as _added_/_deleted_. Notifications can just refer
1468
-
to the version in which the change was made:
1446
+
Use section notifications to annotate an entire page or section.
1469
1447
1470
1448
[source,asciidoc]
1471
1449
----------------------------------
1472
1450
==== New section
1473
1451
1474
-
added::[0.90.4]
1452
+
ga_stack::[0.90.4]
1475
1453
1476
1454
Text about new functionality...
1477
1455
1478
1456
==== New section not yet released
1479
1457
1480
-
coming::[0.90.9]
1458
+
coming_ess::[]
1481
1459
1482
1460
Text about new functionality...
1483
1461
1484
1462
==== Old section
1485
1463
1486
-
deprecated::[0.90.4]
1464
+
deprecated_serverless::[]
1487
1465
1488
1466
Text about old functionality...
1489
1467
----------------------------------
1490
1468
1491
-
==== New section
1492
-
1493
-
added::[0.90.4]
1494
-
1495
-
Text about new functionality...
1496
-
1497
-
==== New section not yet released
1498
-
1499
-
coming::[0.90.9]
1500
-
1501
-
Text about new functionality...
1502
-
1503
-
==== Old section
1504
-
1505
-
deprecated::[0.90.4]
1506
-
1507
-
Text about old functionality...
1508
-
1509
-
[[with_details]]
1510
-
==== With details...
1511
-
1512
-
Or they can include extra text, including more
1513
-
Asciidoc markup:
1469
+
In some cases you can add extra text, including more Asciidoc markup.
1470
+
For example:
1514
1471
1515
1472
[source,asciidoc]
1516
1473
----------------------------------
1517
-
[[new-section]]
1518
-
==== New section
1519
-
1520
-
added::[0.90.4,Replaces `foo.bar`. See <<old-section>>]
1521
-
1522
-
Text about new functionality...
1523
-
1524
1474
[[coming-section]]
1525
1475
==== New section not yet released
1526
1476
1527
1477
coming::[0.90.9,Replaces `foo.bar`. See <<old-section>>]
1528
1478
1529
1479
Text about new functionality...
1530
-
1531
-
[[old-section]]
1532
-
==== Old section
1533
-
1534
-
deprecated::[0.90.4,Replace by `foo.baz`. See <<new-section>>]
1535
-
1536
-
Text about old functionality...
1537
1480
----------------------------------
1538
1481
1539
-
[[new-section]]
1540
-
==== New section
1541
-
1542
-
added::[0.90.4,Replaces `foo.bar`. See <<old-section>>]
1543
-
1544
-
Text about new functionality...
1545
-
1546
-
[[old-section]]
1547
-
==== Old section
1548
-
1549
-
deprecated::[0.90.4,Replace by `foo.baz`. See <<new-section>>]
1550
-
1551
-
Text about old functionality...
1552
-
1553
1482
[[experimental]]
1554
1483
== Beta, Dev, and Preview (experimental)
1555
1484
1556
-
APIs or parameters that are in beta, in development, or in technical preview (formerly experimental) can be
1485
+
Functionality that is in beta, in development, or in technical preview (formerly experimental) can be
1557
1486
marked as such, using markup similar to that used in <<changes>>.
1487
+
Since a feature might be in different lifecycle stages in different contexts, there are multiple variations of each admonition (for example, `beta`, `beta_ess`, and `beta_serverless`).
1558
1488
1559
1489
In the block format, you have the option of adding a related GitHub issue link.
1560
1490
If both custom text and a GitHub link are provided, the GitHub link **must** be
@@ -1570,15 +1500,15 @@ attribute in place of the GitHub issue link.
0 commit comments