Convert a README to mdx to get it slurped up by the new docs system (#…

…84834) * Convert readme to mdx so it can get slurped into the new docs system * Adjust plugin list doc generation so it accounts for mdx readmes * fix eslint of discover_plugin file * Fix link to readme in plugin list Co-authored-by: Kibana Machine <[email protected]>
elastic · Dec 8, 2020 · de15f16 · de15f16
1 parent e74cb40
commit de15f16
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc
@@ -47,7 +47,7 @@ as uiSettings within the code.
 - Adds a dashboard embeddable that can be used in other applications.
 
 
-|{kib-repo}blob/{branch}/src/plugins/data/README.md[data]
+|{kib-repo}blob/{branch}/src/plugins/data/README.mdx[data]
 |The data plugin provides common data access services, such as search and query, for solutions and application developers.
 
 

diff --git a/packages/kbn-dev-utils/src/plugin_list/discover_plugins.ts b/packages/kbn-dev-utils/src/plugin_list/discover_plugins.ts
@@ -38,7 +38,9 @@ export interface Plugin {
 export type Plugins = Plugin[];
 
 const getReadmeName = (directory: string) =>
-  Fs.readdirSync(directory).find((name) => name.toLowerCase() === 'readme.md');
+  Fs.readdirSync(directory).find(
+    (name) => name.toLowerCase() === 'readme.md' || name.toLowerCase() === 'readme.mdx'
+  );
 
 const getReadmeAsciidocName = (directory: string) =>
   Fs.readdirSync(directory).find((name) => name.toLowerCase() === 'readme.asciidoc');

diff --git 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_]).mdx',
   '**/+([A-Z_]).asciidoc',
   '**/LICENSE',
   '**/*.txt',

diff --git a/src/plugins/data/README.md → src/plugins/data/README.mdx b/src/plugins/data/README.md → src/plugins/data/README.mdx
@@ -1,3 +1,13 @@
+---
+id: kibDataPlugin
+slug: /kibana-dev-guide/services/data-plugin
+title: Data services
+image: https://source.unsplash.com/400x175/?Search
+summary: The data plugin contains services for searching, querying and filtering.
+date: 2020-12-02
+tags: ['kibana','dev', 'contributor', 'api docs']
+---
+
 # data
 
 The data plugin provides common data access services, such as `search` and `query`, for solutions and application developers.