Added DSL documentation to Guide #2761
Conversation
|
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
miguelgrinberg
force-pushed
the
dsl-added-to-guide
branch
3 times, most recently
from
5bd71ce to
3a03b40
Compare
miguelgrinberg
force-pushed
the
dsl-added-to-guide
branch
from
3a03b40 to
849b87e
Compare
| include::dsl/configuration.asciidoc[] | ||
| include::dsl/tutorials.asciidoc[] | ||
| include::dsl/howto.asciidoc[] | ||
| include::dsl/examples.asciidoc[] |
There was a problem hiding this comment.
Can we also add links to those sections? On mobile the navigation is at the bottom of the page and easy to miss.
There was a problem hiding this comment.
I agree that it would be good to add these links, but the way this is currently implemented is hacky. The links that appear in the body (as opposite to those that are in the sidebar) are implemented in an HTML file, not an asciidoc file. The only links that are currently in the body are links to top-level sections. I'm not sure there is a robust way of adding links to sub-sections, since these links are generated by asciidoc.
I'm not going to implement this right now, I think we should wait until the docs migrate and then we can see what can be done within the new docs system.
* Added DSL documentation to Guide * clarify that this is a Python DSL (cherry picked from commit 8a27080)
* Added DSL documentation to Guide * clarify that this is a Python DSL (cherry picked from commit 8a27080)
* Added DSL documentation to Guide * clarify that this is a Python DSL (cherry picked from commit 8a27080)
* Added DSL documentation to Guide * clarify that this is a Python DSL (cherry picked from commit 8a27080)
This adds the DSL documentation (not including the reference sections) to the documentation guide.
The contents are mostly translated from the original RST sources, without any major changes. There are improvements that can be made to the content as well, such as showing the new typed syntax in code blocks, which I'll address separately.