Shortcut to build asciidocs #13164
Shortcut to build asciidocs #13164
Conversation
The command to build the Kibana docs using the elastic/docs repo can be easy to forget, so this script is an easy to way to do it right every time.
src/docs/cli.js
Outdated
|
|
||
| const kibanaDir = resolve(__dirname, '..', '..'); | ||
| const docsIndexFile = resolve(kibanaDir, 'docs', 'index.asciidoc'); | ||
| const docsToolDir = resolve(kibanaDir, '..', 'docs'); |
There was a problem hiding this comment.
Could we add a fallback for elastic-docs? I can't stand having a docs project in my dev directory
There was a problem hiding this comment.
How about an environment variable fallback? I'm not a big fan of hardcoding alternatives
There was a problem hiding this comment.
I would prefer a command line flag if it's going to be an argument
For folks that clone the elastic docs repo to a different location than as a sibling of kibana.
|
I made the docs repo location configurable via the The drawback to this approach is that this will no longer pass all CLI arguments along to the underlying docs build tool. I didn't want to do any I think this is OK because this script is intended to be used specifically during development for Kibana docs rather than as a proxy/replacement for the full capabilities of the docs repo itself. |
|
@spalger This is good for your review again |
* Shortcut to build asciidocs The command to build the Kibana docs using the elastic/docs repo can be easy to forget, so this script is an easy to way to do it right every time. * Configurable docs repo location For folks that clone the elastic docs repo to a different location than as a sibling of kibana.
* Shortcut to build asciidocs The command to build the Kibana docs using the elastic/docs repo can be easy to forget, so this script is an easy to way to do it right every time. * Configurable docs repo location For folks that clone the elastic docs repo to a different location than as a sibling of kibana.
* Shortcut to build asciidocs The command to build the Kibana docs using the elastic/docs repo can be easy to forget, so this script is an easy to way to do it right every time. * Configurable docs repo location For folks that clone the elastic docs repo to a different location than as a sibling of kibana.
The command to build the Kibana docs using the elastic/docs repo can be
easy to forget, so this script is an easy to way to do it right every
time.