Update Styleguide path to .mdx (elastic#107890)

* Fix Styleduide URL STYLEGUIDE.md -> STYLEGUIDE.mdx * Fix type for a path to the scripts folder
dominiqueclarke · Aug 10, 2021 · 8f22fed · 8f22fed
1 parent 204efae
commit 8f22fed
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 7 deletions.
diff --git a/STYLEGUIDE.mdx b/STYLEGUIDE.mdx
@@ -35,7 +35,7 @@ remove it, don't simply comment it out.
 
 We are gradually moving the Kibana code base over to Prettier. All TypeScript code
 and some JavaScript code (check `.eslintrc.js`) is using Prettier to format code. You
-can run `node script/eslint --fix` to fix linting issues and apply Prettier formatting.
+can run `node scripts/eslint --fix` to fix linting issues and apply Prettier formatting.
 We recommend you to enable running ESLint via your IDE.
 
 Whenever possible we are trying to use Prettier and linting over written style guide rules.

diff --git a/dev_docs/best_practices.mdx b/dev_docs/best_practices.mdx
@@ -171,7 +171,7 @@ Kibana is translated into other languages. Use our i18n utilities to ensure your
 
 ## Styleguide
 
-We use es-lint rules when possible, but please review our [styleguide](https://github.com/elastic/kibana/blob/master/STYLEGUIDE.md), which includes recommendations that can't be linted on.
+We use es-lint rules when possible, but please review our [styleguide](https://github.com/elastic/kibana/blob/master/STYLEGUIDE.mdx), which includes recommendations that can't be linted on.
 
 Es-lint overrides on a per-plugin level are discouraged.
 

diff --git a/docs/developer/best-practices/index.asciidoc b/docs/developer/best-practices/index.asciidoc
@@ -45,7 +45,7 @@ guidelines]
 === Conventions
 
 * Become familiar with our
-{kib-repo}blob/{branch}/STYLEGUIDE.md[styleguide]
+{kib-repo}blob/{branch}/STYLEGUIDE.mdx[styleguide]
 (use Typescript!)
 * Write all new code on
 {kib-repo}blob/{branch}/src/core/README.md[the

diff --git a/docs/developer/contributing/linting.asciidoc b/docs/developer/contributing/linting.asciidoc
@@ -2,7 +2,7 @@
 == Linting
 
 A note about linting: We use http://eslint.org[eslint] to check that the
-link:STYLEGUIDE.md[styleguide] is being followed. It runs in a
+link:STYLEGUIDE.mdx[styleguide] is being followed. It runs in a
 pre-commit hook and as a part of the tests, but most contributors
 integrate it with their code editors for real-time feedback.
 

diff --git a/docs/developer/contributing/pr-review.asciidoc b/docs/developer/contributing/pr-review.asciidoc
@@ -75,7 +75,7 @@ Reviewers are not simply evaluating the code itself, they are also evaluating th
 
 Having a relatively consistent codebase is an important part of us building a sustainable project. With dozens of active contributors at any given time, we rely on automation to help ensure consistency - we enforce a comprehensive set of linting rules through CI. We're also rolling out prettier to make this even more automatic.
 
-For things that can't be easily automated, we maintain a link:{kib-repo}tree/{branch}/STYLEGUIDE.md[style guide] that authors should adhere to and reviewers should keep in mind when they review a pull request.
+For things that can't be easily automated, we maintain a link:{kib-repo}tree/{branch}/STYLEGUIDE.mdx[style guide] that authors should adhere to and reviewers should keep in mind when they review a pull request.
 
 Beyond that, we're into subjective territory. Statements like "this isn't very readable" are hardly helpful since they can't be qualified, but that doesn't mean a reviewer should outright ignore code that is hard to understand due to how it is written. There isn't one definitively "best" way to write any particular code, so pursuing such shouldn't be our goal. Instead, reviewers and authors alike must accept that there are likely many different appropriate ways to accomplish the same thing with code, and so long as the contribution is utilizing one of those ways, then we're in good shape.
 

diff --git a/examples/routing_example/README.md b/examples/routing_example/README.md
@@ -6,4 +6,4 @@ Read more:
 
 - [IRouter API Docs](../../docs/development/core/server/kibana-plugin-core-server.irouter.md)
 - [HttpHandler (core.http.fetch) API Docs](../../docs/development/core/public/kibana-plugin-core-public.httphandler.md)
-- [Routing Conventions](../../STYLEGUIDE.md#api-endpoints)
+- [Routing Conventions](../../STYLEGUIDE.mdx#api-endpoints)
diff --git a/examples/routing_example/public/app.tsx b/examples/routing_example/public/app.tsx
@@ -63,7 +63,8 @@ function RoutingExplorer({
                 },
                 {
                   label: 'Conventions',
-                  href: 'https://github.com/elastic/kibana/tree/master/STYLEGUIDE.md#api-endpoints',
+                  href:
+                    'https://github.com/elastic/kibana/tree/master/STYLEGUIDE.mdx#api-endpoints',
                   iconType: 'logoGithub',
                   target: '_blank',
                   size: 's',