Skip to content

Add a plugin directory page to the docs build#112862

Merged
stacey-gammon merged 7 commits intoelastic:masterfrom
stacey-gammon:2021-09-22-plugin-index-page
Sep 28, 2021
Merged

Add a plugin directory page to the docs build#112862
stacey-gammon merged 7 commits intoelastic:masterfrom
stacey-gammon:2021-09-22-plugin-index-page

Conversation

@stacey-gammon
Copy link

@stacey-gammon stacey-gammon commented Sep 22, 2021

I'm open for suggestions on the formatting of the page. Torn on whether a table is the right format, or using sections instead. Perhaps once the description property is taken advantage of more, sections will be better.

Screen Shot 2021-09-22 at 4 39 08 PM

@stacey-gammon stacey-gammon requested review from a team as code owners September 22, 2021 17:55
@stacey-gammon stacey-gammon added release_note:skip Skip the PR/issue when compiling release notes v7.16.0 v8.0.0 labels Sep 22, 2021
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@mattkime
Copy link
Contributor

@stacey-gammon Overall this looks good but I'm curious about how the produced files will be updated. Will it be like api doc generator we were using up until recently?

@stacey-gammon
Copy link
Author

@mattkime - it gets updated when node scripts/build_api_docs runs, which gets run whenever I manually run it, which is about once a month. @tylersmalley told me yesterday he has some ideas to work this into ci so it's automatically updated with every PR!

Copy link
Contributor

@mattkime mattkime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! Definitely helpful in navigating the list of plugins and encouraging code quality improvements.

@stacey-gammon stacey-gammon merged commit 20202f7 into elastic:master Sep 28, 2021
@stacey-gammon stacey-gammon added the auto-backport Deprecated - use backport:version if exact versions are needed label Sep 28, 2021
@kibanamachine
Copy link
Contributor

💔 Backport failed

Status Branch Result
7.x Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 112862

stacey-gammon pushed a commit to stacey-gammon/kibana that referenced this pull request Sep 28, 2021
* Write plugin directory doc as part of api docs build.

* Replace service folder with the new name for index patterns

* Updated docs

* small update

* update docs
# Conflicts:
#	api_docs/actions.mdx
#	api_docs/apm.json
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_data_views.json
#	api_docs/data_data_views.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.json
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/event_log.mdx
#	api_docs/maps.json
#	api_docs/maps.mdx
#	api_docs/maps_ems.json
#	api_docs/maps_ems.mdx
#	api_docs/observability.mdx
#	api_docs/saved_objects.json
#	api_docs/security_solution.mdx
stacey-gammon pushed a commit that referenced this pull request Sep 28, 2021
* Write plugin directory doc as part of api docs build.

* Replace service folder with the new name for index patterns

* Updated docs

* small update

* update docs
# Conflicts:
#	api_docs/actions.mdx
#	api_docs/apm.json
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_data_views.json
#	api_docs/data_data_views.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.json
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/event_log.mdx
#	api_docs/maps.json
#	api_docs/maps.mdx
#	api_docs/maps_ems.json
#	api_docs/maps_ems.mdx
#	api_docs/observability.mdx
#	api_docs/saved_objects.json
#	api_docs/security_solution.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes v7.16.0 v8.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants