Skip to content

Commit

Permalink
Remove lingering Asciidoc (Python) reference from README
Browse files Browse the repository at this point in the history
The Elastic doc toolchain migrated from the original Python Asciidoc
to Asciidoctor, a re-implementation in Ruby (tracked in elastic#505).

During the migration, the README referenced both Asciidoc and
Asciidoctor. After the migration, elastic#1414 removed all references to the
original Asciidoc and standardized the README on Asciidoctor. However, I
found one lingering reference to the days when both tools were being
used.

Remove a reference to the obsolete `--asciidoctor` command line option
and a note about Asciidoc vs Asciidoctor.
  • Loading branch information
chriscressman committed Nov 27, 2019
1 parent bdfa417 commit ce9800c
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -147,13 +147,11 @@ users to specify their preferred language or client. You can do this by passing
[source,bash]
----------------------------
cd docs/
./build_docs --doc README.asciidoc --open --asciidoctor \
./build_docs --doc README.asciidoc --open \
--alternatives console:js:integtest/readme_examples/js \
--alternatives console:csharp:integtest/readme_examples/csharp
----------------------------

NOTE: This is only supported by Asciidoctor, not AsciiDoc.

== Correcting errors

Asciidoc is converted to DocBook, which is then converted to HTML.
Expand Down

0 comments on commit ce9800c

Please sign in to comment.