Skip to content

Switch ruby client docs to asciidoctor #691

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 1 commit into from
Mar 8, 2019

Conversation

nik9000
Copy link
Member

@nik9000 nik9000 commented Mar 8, 2019

This switches building the ruby client docs from AsciiDoc to
Asciidoctor. The html that it produces isn't 100% the same, but most the
differences aren't relevant. Here is a diff of the relevant stuff:
https://gist.github.com/nik9000/92e098ca9d9ce113f5d795ee1b0017ce

That diff seems like a net positive.

This switches building the ruby client docs from AsciiDoc to
Asciidoctor. The html that it produces isn't 100% the same, but most the
differences aren't relevant. Here is a diff of the relevant stuff:
https://gist.github.com/nik9000/92e098ca9d9ce113f5d795ee1b0017ce

That diff seems like a net positive.
@nik9000 nik9000 requested review from estolfo and lcawl March 8, 2019 20:16
@nik9000 nik9000 mentioned this pull request Mar 8, 2019
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 and builds fine

@lcawl
Copy link
Contributor

lcawl commented Mar 8, 2019

@estolfo Similar to something we've noticed while migrating the other clients, I noticed that there are no explicit anchors for the pages in the books (i.e. no [[anchor_name]] for each page). As a result, they're auto-generated, which could result in changed URLs unintentionally. If you like, I am happy to help add IDs in the source files.

@nik9000 nik9000 merged commit 6eed862 into elastic:master Mar 8, 2019
@nik9000
Copy link
Member Author

nik9000 commented Mar 8, 2019

Thanks for reviewing @lcawl!

@estolfo, when you build these docs locally you'll need to do something like:

$GIT_HOME/docs/build_docs --asciidoctor --doc $GIT_HOME/elasticsearch/docs/ruby/index.asciidoc

Note the lack of .pl on the build and the new --asciidoctor.

@estolfo
Copy link
Contributor

estolfo commented Mar 13, 2019

@lcawl thanks. I'll take a look and see how I can structure the ruby client docs better.

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.

3 participants