Skip to content
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

Add a few asciidoc readmes #72082

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/developer/architecture/code-exploration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
8 changes: 5 additions & 3 deletions examples/README.md → examples/README.asciidoc
Original file line number Diff line number Diff line change
@@ -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
```
----
1 change: 1 addition & 0 deletions src/dev/precommit_hook/casing_check_config.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export const IGNORE_FILE_GLOBS = [
'docs/**/*',
'**/bin/**/*',
'**/+([A-Z_]).md',
'**/+([A-Z_]).asciidoc',
'**/LICENSE',
'**/*.txt',
'**/Gruntfile.js',
Expand Down
5 changes: 5 additions & 0 deletions src/plugins/dashboard/README.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[[kibana-dashboard-plugin]]
== Dashboard plugin

- Registers the dashboard application.
- Adds a dashboard embeddable that can be used in other applications.
6 changes: 6 additions & 0 deletions x-pack/plugins/embeddable_enhanced/README.asciidoc
Original file line number Diff line number Diff line change
@@ -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.

1 change: 0 additions & 1 deletion x-pack/plugins/embeddable_enhanced/README.md

This file was deleted.