Convert styleguide to mdx and add section on export * #99527
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A simple md -> mdx, and one extra section:
Avoid export * in top level index.ts files
The exports in
common/index.ts
,public/index.ts
andserver/index.ts
dictate a plugin's public API. The public API should be carefully controlled, and usingexport *
makes it very easy for a developer working on internal changes to export a new public API unintentionally.I will hopefully get this into the docs system, but having trouble with it picking up the file (see https://github.com/elastic/elastic-docs/pull/323)