Skip to content

Make legacy docs asciidoctor compatible #793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 28, 2019

Conversation

nik9000
Copy link
Member

@nik9000 nik9000 commented Mar 27, 2019

This modifies the legacy client documentation so that it is is
compatible with Asciidoctor. With these changes asciidoctor renders the
same way as asciidoc, module spacing and a couple of auto-generated ids.
I'm willing to ignore the auto-generated anchors because these are
legacy docs.

This modifies the legacy client documentation so that it is is
compatible with Asciidoctor. With these changes asciidoctor renders the
same way as asciidoc, module spacing and a couple of auto-generated ids.
I'm willing to ignore the auto-generated anchors because these are
legacy docs.
@lcawl
Copy link
Contributor

lcawl commented Mar 27, 2019

I tried building with

build_docs --asciidoctor --doc elasticsearch-js/docs/index.asciidoc --chunk 1
build_docs --asciidoctor --doc elasticsearch-js/docs/index.asciidoc
docbldejs

... and they all seemed fine

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@delvedor delvedor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

/cc @spalger

Copy link
Contributor

@spalger spalger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but we need to make sure to update the template for the config docs

@delvedor delvedor requested a review from spalger March 28, 2019 07:23
@delvedor delvedor merged commit d699045 into legacy-doc Mar 28, 2019
@delvedor delvedor deleted the legacy_docs_asciidoctor_compatible branch March 28, 2019 07:31
spalger pushed a commit that referenced this pull request May 2, 2019
* Make legacy docs asciidoctor compatible

This modifies the legacy client documentation so that it is is
compatible with Asciidoctor. With these changes asciidoctor renders the
same way as asciidoc, module spacing and a couple of auto-generated ids.
I'm willing to ignore the auto-generated anchors because these are
legacy docs.

* Updated configuration template

(cherry picked from commit d699045)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants