Add asciidoc support for generated plugin list by stacey-gammon · Pull Request #72292 · elastic/kibana

stacey-gammon · 2020-07-17T15:11:43Z

Adds README asciidoc support so READMEs in asciidoc are now part of the developer guide:

Also:

Rearranged the docs because there is a limit of 3 levels deep in docs. Instead of Developer Guide -> Architecture -> Code exploration -> Plugin Readmes it's now Developer Guide -> Plugin list -> Plugin READMEs. I think it's more discoverable there anyway.

Change the name and contents of the file. The text about the folder hierarchy best practices didn't seem to go in there and just made a long page longer. Now it's just a table of plugins.
Made it a table for better readability:

Before:

After:

gtback · 2020-07-28T18:18:10Z

@elasticmachine run elasticsearch-ci/docs

gtback · 2020-07-28T20:16:59Z

@elasticmachine run elasticsearch-ci/docs

With any luck this will finally pass!

stacey-gammon · 2020-07-29T17:48:16Z

@spalger - any idea why this would fail with "js file outside regularBundlesPath"?

spalger · 2020-07-29T18:01:39Z

That looks a lot like an Angular provider converted to JSON... { '$$id': 4, apply: [Function], call: [Function] } 🤔

stacey-gammon · 2020-07-29T18:08:23Z

I'll sync with master again and 🤞

spalger · 2020-07-29T18:11:43Z

Looks like it's opal-runtime, which is installed by asciidoctor and provides a runtime to run ruby code that's transformed to JS... This seems like an unnecessary amount of impact for a text parser, and the fact that it's injecting globals and breaking tests is pretty concerning. Is there another dependency we can use besides asciidoctor? If not, maybe we can consume it through the CLI rather than via the node API?

stacey-gammon · 2020-07-31T18:26:23Z

@elasticmachine run elasticsearch-ci/docs

gtback · 2020-08-03T13:29:33Z

@stacey-gammon looks like all tests are passing 🙌 !

stacey-gammon · 2020-08-03T13:32:08Z

@elasticmachine run elasticsearch-ci/docs

Thanks @gtback! I lost track of this PR for a couple days. :)

Try level offset "=+2" instead of "=+1" to stop the inlining of the includes. remove +2 back to +1

…g limit.

packages/kbn-dev-utils/src/plugin_list/discover_plugins.ts

…ciidoc-support-for-plugin-list

… the paragraph snippet.

elasticmachine · 2020-08-05T15:47:37Z

Pinging @elastic/kibana-operations (Team:Operations)

spalger · 2020-08-05T15:49:31Z

@stacey-gammon when we make changes to the readme files, and then in turn update the plugin list in the docs, are we verifying the syntax is valid in CI? (via elasticsearch-ci/docs I assume)

cjcenizal

Removal of the empty grokdebugger README LGTM.

gtback · 2020-08-05T18:10:40Z

@spalger yes, any of the Asciidoc files that get included in the build process will be validated by elasticsearch-ci/docs which rebuilds documentation for any of the files that have changed.

spalger

LGTM, one little totally ignorable nitpick

spalger · 2020-08-05T18:32:56Z

packages/kbn-dev-utils/src/plugin_list/extract_asciidoc_info.test.ts

+  const { firstParagraph, anchor } = extractAsciidocInfo(
+    `[[this-is-the-anchor]]
+== Heading here
+
+Intro.
+
+=== Another heading
+
+More details`
+  );
+
+  expect(firstParagraph).toEqual(`Intro.`);
+  expect(anchor).toEqual('this-is-the-anchor');


I'm sure you've got your reasons for not preferring this, but wanted to suggest considering inline snapshots

import dedent from 'dedent'; //... expect( extractAsciidocInfo(dedent` [[this-is-the-anchor]] == Heading here Intro. === Another heading More details `) ).toMatchInlineSnapshot(...autogenerated by jest...)

stacey-gammon · 2020-08-24T12:29:58Z

Thought I merged this weeks ago 🤦‍♀️ .

…ciidoc-support-for-plugin-list

kertal · 2020-08-24T13:24:59Z

x-pack/plugins/dashboard_enhanced/README.asciidoc

+[[dashboard-enhanced-plugin]]
+== Dashboard app enhancements plugin
+
+Adds drilldown capabailities to dashboard.  Owned by the Kibana App team.


Seems to be a typo here (capabailities):

Suggested change

Adds drilldown capabailities to dashboard. Owned by the Kibana App team.

Adds drilldown capabilities to dashboard. Owned by the Kibana App team.

Fixed, thanks for the review!

kertal

Apart from a minor typo, KibanaApp owned code LGTM. didn't test.

kibanamachine · 2020-08-24T15:27:05Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 77c8e1d

Build metrics

✅ unchanged

History

💚 Build #69969 succeeded 261d973
💔 Build #69962 failed 6c6b733
💚 Build #66641 succeeded e157230
💔 Build #66636 failed ae8a554
💚 Build #66481 succeeded 4b494f4

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

* add asciidoc support for generated plugin list Try level offset "=+2" instead of "=+1" to stop the inlining of the includes. remove +2 back to +1 * Remove asciidoc, switch to regex. Rearrange dev guide to avoid nesting limit. * Add tests for regex * add a description to not throw off the table. Remove the heading from the paragraph snippet. * Fix more READMEs so table renders correctly * Update plugin list * Remove code-exploration file, moved to plugin-list * fix typo * Add link to developer examples * Update plugin list * fix typo # Conflicts: # docs/developer/architecture/code-exploration.asciidoc

kibanamachine · 2020-08-26T15:38:45Z

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

stacey-gammon force-pushed the 2020-07-17-asciidoc-support-for-plugin-list branch 3 times, most recently from 0edf151 to ae995aa Compare July 21, 2020 15:57

stacey-gammon mentioned this pull request Jul 27, 2020

Add paths to Kibana docs elastic/docs#1917

Closed

stacey-gammon force-pushed the 2020-07-17-asciidoc-support-for-plugin-list branch 2 times, most recently from 45466c9 to a8d024d Compare July 28, 2020 17:44

stacey-gammon force-pushed the 2020-07-17-asciidoc-support-for-plugin-list branch from a8d024d to a1131b2 Compare July 28, 2020 18:48

stacey-gammon force-pushed the 2020-07-17-asciidoc-support-for-plugin-list branch 4 times, most recently from 1d4a2d0 to 9beaa8a Compare July 29, 2020 14:30

stacey-gammon force-pushed the 2020-07-17-asciidoc-support-for-plugin-list branch from 9beaa8a to 4bb7f5a Compare July 29, 2020 18:08

stacey-gammon force-pushed the 2020-07-17-asciidoc-support-for-plugin-list branch 2 times, most recently from 2d6c609 to b83d12a Compare July 31, 2020 15:53

Stacey Gammon added 2 commits August 3, 2020 09:32

add asciidoc support for generated plugin list

1ccbd48

Try level offset "=+2" instead of "=+1" to stop the inlining of the includes. remove +2 back to +1

Remove asciidoc, switch to regex. Rearrange dev guide to avoid nestin…

acc37d9

…g limit.

stacey-gammon force-pushed the 2020-07-17-asciidoc-support-for-plugin-list branch from b83d12a to acc37d9 Compare August 3, 2020 13:32

spalger reviewed Aug 3, 2020

View reviewed changes

packages/kbn-dev-utils/src/plugin_list/discover_plugins.ts Outdated Show resolved Hide resolved

Stacey Gammon added 3 commits August 4, 2020 14:00

Add tests for regex

175ab92

Merge branch 'master' of github.com:elastic/kibana into 2020-07-17-as…

17c3ff2

…ciidoc-support-for-plugin-list

add a description to not throw off the table. Remove the heading from…

04abd31

… the paragraph snippet.

stacey-gammon added review Team:Operations Kibana-Operations Team labels Aug 5, 2020

cjcenizal approved these changes Aug 5, 2020

View reviewed changes

spalger mentioned this pull request Aug 5, 2020

[Jenkins] run CI when plugin readmes change #74388

Merged

spalger approved these changes Aug 5, 2020

View reviewed changes

Stacey Gammon added 5 commits August 24, 2020 08:38

Merge branch 'master' of github.com:elastic/kibana into 2020-07-17-as…

65b3c10

…ciidoc-support-for-plugin-list

Remove code-exploration file, moved to plugin-list

6c6b733

fix typo

a21c8ce

Add link to developer examples

b561c5f

Update plugin list

261d973

kertal reviewed Aug 24, 2020

View reviewed changes

kertal approved these changes Aug 24, 2020

View reviewed changes

fix typo

77c8e1d

lukeelmers approved these changes Aug 24, 2020

View reviewed changes

stacey-gammon merged commit 4ffef0a into elastic:master Aug 24, 2020

stacey-gammon mentioned this pull request Aug 24, 2020

[7.x] Add asciidoc support for generated plugin list (#72292) #75772

Closed

stacey-gammon mentioned this pull request Aug 24, 2020

[7.x] Add asciidoc support for generated plugin list (#72292) #75778

Merged

7 tasks

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 26, 2020

stacey-gammon removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 26, 2020

spalger added the backported label Aug 26, 2020

	Adds drilldown capabailities to dashboard. Owned by the Kibana App team.
	Adds drilldown capabilities to dashboard. Owned by the Kibana App team.

Conversation

stacey-gammon commented Jul 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gtback commented Jul 28, 2020

Uh oh!

gtback commented Jul 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stacey-gammon commented Jul 29, 2020

Uh oh!

spalger commented Jul 29, 2020

Uh oh!

stacey-gammon commented Jul 29, 2020

Uh oh!

spalger commented Jul 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stacey-gammon commented Jul 31, 2020

Uh oh!

gtback commented Aug 3, 2020

Uh oh!

stacey-gammon commented Aug 3, 2020

Uh oh!

Uh oh!

elasticmachine commented Aug 5, 2020

Uh oh!

spalger commented Aug 5, 2020

Uh oh!

cjcenizal left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtback commented Aug 5, 2020

Uh oh!

spalger left a comment

Choose a reason for hiding this comment

Uh oh!

spalger Aug 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stacey-gammon commented Aug 24, 2020

Uh oh!

kertal Aug 24, 2020

Choose a reason for hiding this comment

Uh oh!

stacey-gammon Aug 24, 2020

Choose a reason for hiding this comment

Uh oh!

kertal left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Aug 24, 2020

💚 Build Succeeded

Build metrics

History

Uh oh!

kibanamachine commented Aug 26, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

stacey-gammon commented Jul 17, 2020 •

edited

Loading

gtback commented Jul 28, 2020 •

edited

Loading

spalger commented Jul 29, 2020 •

edited

Loading

cjcenizal left a comment •

edited

Loading

spalger Aug 5, 2020 •

edited

Loading