Skip to content

Commit c453724

Browse files
committed
Edit build errors; update readme
1 parent 27d4dba commit c453724

File tree

4 files changed

+78
-148
lines changed

4 files changed

+78
-148
lines changed

README.asciidoc

Lines changed: 32 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1399,23 +1399,16 @@ The path should be as specific as possible because we skip rebuilding books if
13991399
changes to the referenced repository don't change the referenced path.
14001400

14011401
[[changes]]
1402-
== Additions and deprecations
1402+
== Additions, deprecations, and discontinuations
14031403

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_.
14081406

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.
14181409

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.
14191412

14201413
=== Inline notifications
14211414

@@ -1425,33 +1418,20 @@ the addition or deprecation of individual parameters.
14251418
[source,asciidoc]
14261419
----------------------------------
14271420
[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:[]
14311424
----------------------------------
14321425

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:
14411427

14421428
[source,asciidoc]
14431429
----------------------------------
14441430
[horizontal]
1445-
`foo.bar`:: Does XYZ. added:[0.90.4,Replaces `foo.baz`]
14461431
`foo.bar`:: Does XYZ. coming:[0.90.4,Replaces `foo.baz`]
14471432
`foo.baz`:: Does XYZ. deprecated:[0.90.4,Replaced by `foo.bar`]
14481433
----------------------------------
14491434

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-
14551435
[NOTE]
14561436
====
14571437
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
14631443

14641444
=== Section notifications
14651445

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.
14691447

14701448
[source,asciidoc]
14711449
----------------------------------
14721450
==== New section
14731451
1474-
added::[0.90.4]
1452+
ga_stack::[0.90.4]
14751453
14761454
Text about new functionality...
14771455
14781456
==== New section not yet released
14791457
1480-
coming::[0.90.9]
1458+
coming_ess::[]
14811459
14821460
Text about new functionality...
14831461
14841462
==== Old section
14851463
1486-
deprecated::[0.90.4]
1464+
deprecated_serverless::[]
14871465
14881466
Text about old functionality...
14891467
----------------------------------
14901468

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:
15141471

15151472
[source,asciidoc]
15161473
----------------------------------
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-
15241474
[[coming-section]]
15251475
==== New section not yet released
15261476
15271477
coming::[0.90.9,Replaces `foo.bar`. See <<old-section>>]
15281478
15291479
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...
15371480
----------------------------------
15381481

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-
15531482
[[experimental]]
15541483
== Beta, Dev, and Preview (experimental)
15551484

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
15571486
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`).
15581488

15591489
In the block format, you have the option of adding a related GitHub issue link.
15601490
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.
15701500
15711501
beta::[]
15721502
1573-
beta::[https://github.com/elastic/docs/issues/505]
1503+
beta_serverless::[https://github.com/elastic/docs/issues/505]
15741504
15751505
beta::[{issue}505]
15761506
1577-
beta::["Custom text goes here."]
1507+
beta_ess::["Custom text goes here."]
15781508
15791509
beta::["Custom text goes here.",https://github.com/elastic/docs/issues/505]
15801510
1581-
beta::["Custom text goes here.",{issue}505]
1511+
beta_serverless::["Custom text goes here.",{issue}505]
15821512
15831513
Text about new feature...
15841514
@@ -1592,11 +1522,11 @@ a new parameter that's in beta:
15921522
This param has been around for ages and won't change.
15931523
15941524
`beta_param`::
1595-
beta:[]
1525+
beta:[]
15961526
This param is in beta and may change in the future.
15971527
15981528
`beta_param`::
1599-
beta:["Custom text goes here."]
1529+
beta_serverless:["Custom text goes here."]
16001530
This param is in beta and may change in the future.
16011531
----
16021532

@@ -1609,15 +1539,15 @@ This param is in beta and may change in the future.
16091539
16101540
dev::[]
16111541
1612-
dev::[https://github.com/elastic/docs/issues/505]
1542+
dev_serverless::[https://github.com/elastic/docs/issues/505]
16131543
16141544
dev::[{issue}505]
16151545
1616-
dev::["Custom text goes here."]
1546+
dev_ess::["Custom text goes here."]
16171547
16181548
dev::["Custom text goes here.",https://github.com/elastic/docs/issues/505]
16191549
1620-
dev::["Custom text goes here.",{issue}505]
1550+
dev_serverless::["Custom text goes here.",{issue}505]
16211551
16221552
Text about feature in development...
16231553
@@ -1635,7 +1565,7 @@ dev:[]
16351565
This param is in development and may change in the future.
16361566
16371567
`dev_param`::
1638-
dev:["Custom text goes here."]
1568+
dev_ess:["Custom text goes here."]
16391569
This param is in development and may change in the future.
16401570
----
16411571

@@ -1656,15 +1586,15 @@ See below.
16561586
16571587
preview::[]
16581588
1659-
preview::[https://github.com/elastic/docs/issues/505]
1589+
preview_serverless::[https://github.com/elastic/docs/issues/505]
16601590
16611591
preview::[{issue}505]
16621592
1663-
preview::["Custom text goes here."]
1593+
preview_ess::["Custom text goes here."]
16641594
16651595
preview::["Custom text goes here.",https://github.com/elastic/docs/issues/505]
16661596
1667-
preview::["Custom text goes here.",{issue}505]
1597+
preview_serverless::["Custom text goes here.",{issue}505]
16681598
16691599
Text about new feature...
16701600
@@ -1682,7 +1612,7 @@ preview:[]
16821612
This param is in technical preview and may change in the future.
16831613
16841614
`experimental_param`::
1685-
preview:["Custom text goes here."]
1615+
preview_ess:["Custom text goes here."]
16861616
This param is in technical preview and may change in the future.
16871617
----
16881618

resources/asciidoctor/lib/change_admonition/extension.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
# Usage
1010
#
1111
# added::[6.0.0-beta1]
12-
# gastack::[8.10]
12+
# ga_stack::[8.10]
1313
# coming::[6.0.0-beta1]
1414
# deprecated::[6.0.0-beta1]
15-
# discontinuedstack::[9.0.0]
15+
# discontinued_stack::[9.0.0]
1616
# Foo added:[6.0.0-beta1]
1717
# Foo coming:[6.0.0-beta1]
1818
# Foo deprecated:[6.0.0-beta1]
19-
# Foo gastack:[8.10]
20-
# Foo discontinuedstack:[9.0.0]
19+
# Foo ga_stack:[8.10]
20+
# Foo discontinued_stack:[9.0.0]
2121
#
2222
class ChangeAdmonition < Asciidoctor::Extensions::Group
2323
MACRO_CONF = [

resources/asciidoctor/spec/care_admonition_spec.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ def expect_inline_admonition(text)
232232
end
233233
include_examples 'care admonition'
234234
end
235-
context 'beta-serverless' do
236-
let(:key) { 'beta-serverless' }
235+
context 'beta serverless' do
236+
let(:key) { 'beta_serverless' }
237237
let(:admon_class) { 'warning' }
238238
let(:default_text) do
239239
<<~TEXT.strip

0 commit comments

Comments
 (0)