From 87c61b993721e1845a9289302c04574c62c7f732 Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Thu, 16 Jul 2020 11:28:00 -0400 Subject: [PATCH 1/2] Add a few asciidoc readmes --- examples/{README.md => README.asciidoc} | 8 +++++--- src/dev/precommit_hook/casing_check_config.js | 1 + src/plugins/dashboard/README.asciidoc | 5 +++++ x-pack/plugins/embeddable_enhanced/README.asciidoc | 6 ++++++ x-pack/plugins/embeddable_enhanced/README.md | 1 - 5 files changed, 17 insertions(+), 4 deletions(-) rename examples/{README.md => README.asciidoc} (68%) create mode 100644 src/plugins/dashboard/README.asciidoc create mode 100644 x-pack/plugins/embeddable_enhanced/README.asciidoc delete mode 100644 x-pack/plugins/embeddable_enhanced/README.md diff --git a/examples/README.md b/examples/README.asciidoc similarity index 68% rename from examples/README.md rename to examples/README.asciidoc index 2b214a8d1eb525..d33c5e825ce12a 100644 --- a/examples/README.md +++ b/examples/README.asciidoc @@ -1,7 +1,9 @@ -## Example plugins +[[example-plugins]] +== Example plugins This folder contains example plugins. To run the plugins in this folder, use the `--run-examples` flag, via -``` +[source,bash] +---- yarn start --run-examples -``` +---- diff --git a/src/dev/precommit_hook/casing_check_config.js b/src/dev/precommit_hook/casing_check_config.js index 6b1f1dfaeabb43..929de8c6701d4a 100644 --- a/src/dev/precommit_hook/casing_check_config.js +++ b/src/dev/precommit_hook/casing_check_config.js @@ -30,6 +30,7 @@ export const IGNORE_FILE_GLOBS = [ 'docs/**/*', '**/bin/**/*', '**/+([A-Z_]).md', + '**/+([A-Z_]).asciidoc', '**/LICENSE', '**/*.txt', '**/Gruntfile.js', diff --git a/src/plugins/dashboard/README.asciidoc b/src/plugins/dashboard/README.asciidoc new file mode 100644 index 00000000000000..78163b14c14d6d --- /dev/null +++ b/src/plugins/dashboard/README.asciidoc @@ -0,0 +1,5 @@ +[[kibana-dashboard-plugin]] +== Dashboard plugin + +- Registers the dashboard application. +- Adds a dashboard embeddable that can be used in other applications. \ No newline at end of file diff --git a/x-pack/plugins/embeddable_enhanced/README.asciidoc b/x-pack/plugins/embeddable_enhanced/README.asciidoc new file mode 100644 index 00000000000000..9a7fe9c2669d97 --- /dev/null +++ b/x-pack/plugins/embeddable_enhanced/README.asciidoc @@ -0,0 +1,6 @@ +[[enhanced-embeddables-plugin]] +== Enhanced embeddables plugin + +Enhances Embeddables by registering a custom factory provider. The enhanced factory provider +adds dynamic actions to every embeddables state, in order to support drilldowns. + diff --git a/x-pack/plugins/embeddable_enhanced/README.md b/x-pack/plugins/embeddable_enhanced/README.md deleted file mode 100644 index a0be90731fdb02..00000000000000 --- a/x-pack/plugins/embeddable_enhanced/README.md +++ /dev/null @@ -1 +0,0 @@ -# X-Pack part of `embeddable` plugin From e9ffb992ccf9fff489a219d98499ca7a2bdbfe4b Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Thu, 16 Jul 2020 15:32:37 -0400 Subject: [PATCH 2/2] add updated code-exploration. Need to fix the script in another go to add asciidoc support. The snippet didn't show up anyway. --- docs/developer/architecture/code-exploration.asciidoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/developer/architecture/code-exploration.asciidoc b/docs/developer/architecture/code-exploration.asciidoc index 23ba1c54d27d39..bed54277c82b4a 100644 --- a/docs/developer/architecture/code-exploration.asciidoc +++ b/docs/developer/architecture/code-exploration.asciidoc @@ -365,7 +365,10 @@ WARNING: Missing README. WARNING: Missing README. -- {kib-repo}blob/{branch}/x-pack/plugins/embeddable_enhanced/README.md[embeddableEnhanced] +- {kib-repo}blob/{branch}/x-pack/plugins/embeddable_enhanced[embeddableEnhanced] + +WARNING: Missing README. + - {kib-repo}blob/{branch}/x-pack/plugins/encrypted_saved_objects/README.md[encryptedSavedObjects]