Add plugin list to docs that is generated from the repo #71731

spalger · 2020-07-14T19:05:34Z

Generates a list of all plugins with links to their readmes and the first paragraph from the same file. When a readme doesn't exist for a plugin we instead link to the plugin directory and write a warning that the readme does not exist.

This docs file is generated by running node scripts/build_plugin_list_docs (please help me with this name) and is verified to be up-to-date by CI.

…erated-plugin-list-in-docs

stacey-gammon · 2020-07-14T20:27:40Z

This is awesome, thanks!! The only thing I want to play around with is if we change our README.mds to README.asciidocs. After some exploration is looks like asciidoc is not rendered that great inside github itself (no support for include files).

But I think it would be better if the plugin link was part of the asciidoc book and not a direct link to github. Going to see if I can get something decent working, if not, we can check it in with just markdown support for now.

spalger · 2020-07-14T21:19:29Z

@elasticmachine merge upstream

…erated-plugin-list-in-docs

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

spalger · 2020-07-15T15:57:31Z

@elasticmachine merge upstream

Co-authored-by: Stacey Gammon <gammon@elastic.co>

…erated-plugin-list-in-docs

stacey-gammon · 2020-07-15T16:47:32Z

12:39:12 ERROR: 'node scripts/build_plugin_list_docs' caused changes to the following files:
12:39:12
12:39:12 docs/developer/architecture/code-exploration.asciidoc

So cool!!

spalger · 2020-07-15T16:52:33Z

@stacey-gammon the note at the top, and especially the bash blurb, were a little gross looking for my taste. Since we are validating this in CI anyway I moved them to a comment and updated the check which makes CI optional to require CI when changes to this file are detected. (though github is struggling right now so those changes aren't showing up in the PR quite yet)

spalger · 2020-07-15T19:27:25Z

@elasticmachine merge upstream

stacey-gammon · 2020-07-15T20:11:55Z

Looks good! Yes, much nicer to hide the "don't edit this" so it's not rendererd.

cc @KOTungseth or @lcawl - just want to pull your attention to this new file. There is a note at the top of the code-exploration.asciidoc file. This file shouldn't be edited directly.

Is that sufficient to warn the docs team not to use the "edit" links to edit directly? It would break the ci.

Actually @spalger - would the ci check run if I only made a direct edit to the code-exploration file? I think only a subset of checks run if there are no other code changes... will this new check be part of it to ensure no one hand edits the file and checks it in, thus breaking master.

.ci/pipeline-library/src/test/prChanges.groovy

stacey-gammon

So excited!! 🎉 🎉 .

spalger · 2020-07-15T20:14:23Z

I think only a subset of checks run if there are no other code changes... will this new check be part of it to ensure no one hand edits the file and checks it in, thus breaking master.

Yeah, I've extended the logic we use to determine if CI needs to run to make sure that CI runs all tasks if the docs/developer/architecture/code-exploration.asciidoc file is modified 84e54f7 (#71731) and subsquent fix commits

spalger · 2020-07-15T20:19:18Z

@elasticmachine merge upstream

elasticmachine · 2020-07-15T20:19:23Z

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

…erated-plugin-list-in-docs

kibanamachine · 2020-07-16T17:07:23Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: ad70dbf

Build metrics

✅ unchanged

History

💚 Build #62096 succeeded 303a634
💔 Build #62076 failed 9efb2ef
💛 Build #62011 was flaky 32848c1
💔 Build #61974 failed 78db4d5
💚 Build #61707 succeeded 60662a4

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

mistic

That LGTM

Co-authored-by: Stacey Gammon <gammon@elastic.co> Co-authored-by: spalger <spalger@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> # Conflicts: # src/dev/ci_setup/setup.sh

Co-authored-by: Stacey Gammon <gammon@elastic.co> Co-authored-by: spalger <spalger@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> # Conflicts: # docs/developer/architecture/index.asciidoc # src/dev/ci_setup/setup.sh

#72138) Co-authored-by: Stacey Gammon <gammon@elastic.co> Co-authored-by: spalger <spalger@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> # Conflicts: # src/dev/ci_setup/setup.sh

#72139) Co-authored-by: Stacey Gammon <gammon@elastic.co> Co-authored-by: spalger <spalger@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

stacey-gammon and others added 3 commits July 14, 2020 09:52

plugins list

a58f230

Merge branch 'master' of github.com:elastic/kibana into implement/gen…

47645fa

…erated-plugin-list-in-docs

[docs] generate listing of all Kibana plugins in docs

ae2fa56

spalger added Team:Operations Team label for Operations Team v8.0.0 v7.9.0 v7.8.1 labels Jul 14, 2020

spalger mentioned this pull request Jul 14, 2020

[Ops] Script to automatically build a list of plugins, with links to READMEs. #71663

Closed

spalger changed the title ~~Implement/generated plugin list in docs~~ Add plugin list to docs that is generated from the repo Jul 14, 2020

spalger added 3 commits July 14, 2020 12:22

point to built output of kbn/es

e100f3b

revert kbn/es changes

1ca77b3

fix kbn/es revert

b44bbcb

elasticmachine and others added 3 commits July 14, 2020 15:19

Merge branch 'master' into implement/generated-plugin-list-in-docs

f4dc840

ensure that correct types flow from simple discovery helper

4955c26

Merge branch 'master' of github.com:elastic/kibana into implement/gen…

60662a4

…erated-plugin-list-in-docs

stacey-gammon reviewed Jul 15, 2020

View reviewed changes

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

stacey-gammon mentioned this pull request Jul 15, 2020

[discuss] Move to domain-based directory structure #71566

Closed

1 task

elasticmachine and others added 4 commits July 15, 2020 09:57

Merge branch 'master' into implement/generated-plugin-list-in-docs

eb5fdf8

Update packages/kbn-dev-utils/src/plugin_list/generate_plugin_list.ts

78db4d5

Co-authored-by: Stacey Gammon <gammon@elastic.co>

Merge branch 'master' of github.com:elastic/kibana into implement/gen…

6a13421

…erated-plugin-list-in-docs

switch to a comment at the top of the file

c015975

require CI when changes to an autogenerated doc file are made

84e54f7

spalger added 2 commits July 15, 2020 10:08

fix logic in areChangesSkippable()

656bfb0

fix reading not-skippable paths

32848c1

thomasneirynck mentioned this pull request Jul 15, 2020

[Maps] Add readme #71912

Merged

stacey-gammon reviewed Jul 15, 2020

View reviewed changes

.ci/pipeline-library/src/test/prChanges.groovy Show resolved Hide resolved

stacey-gammon approved these changes Jul 15, 2020

View reviewed changes

spalger marked this pull request as ready for review July 15, 2020 20:19

spalger requested a review from a team as a code owner July 15, 2020 20:19

Merge branch 'master' into implement/generated-plugin-list-in-docs

9efb2ef

spalger added the release_note:skip Skip the PR/issue when compiling release notes label Jul 15, 2020

spalger added 3 commits July 15, 2020 14:12

Merge branch 'master' of github.com:elastic/kibana into implement/gen…

3ac5840

…erated-plugin-list-in-docs

update plugin list docs

303a634

Merge branch 'master' of github.com:elastic/kibana into implement/gen…

ad70dbf

…erated-plugin-list-in-docs

stacey-gammon mentioned this pull request Jul 16, 2020

Add a few asciidoc readmes #72082

Merged

mistic approved these changes Jul 16, 2020

View reviewed changes

spalger merged commit 5a755dd into elastic:master Jul 16, 2020

spalger deleted the implement/generated-plugin-list-in-docs branch July 16, 2020 19:17

spalger added the v7.10.0 label Jul 16, 2020

spalger mentioned this pull request Jul 16, 2020

[7.x] Add plugin list to docs that is generated from the repo (#71731) #72138

Merged

spalger mentioned this pull request Jul 16, 2020

[7.9] Add plugin list to docs that is generated from the repo (#71731) #72139

Merged

spalger removed the v7.8.1 label Jul 16, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add plugin list to docs that is generated from the repo #71731

Add plugin list to docs that is generated from the repo #71731

spalger commented Jul 14, 2020

stacey-gammon commented Jul 14, 2020

spalger commented Jul 14, 2020

spalger commented Jul 15, 2020

stacey-gammon commented Jul 15, 2020

spalger commented Jul 15, 2020

spalger commented Jul 15, 2020

stacey-gammon commented Jul 15, 2020

stacey-gammon left a comment

spalger commented Jul 15, 2020

spalger commented Jul 15, 2020

elasticmachine commented Jul 15, 2020

kibanamachine commented Jul 16, 2020

mistic left a comment

Add plugin list to docs that is generated from the repo #71731

Add plugin list to docs that is generated from the repo #71731

Conversation

spalger commented Jul 14, 2020

stacey-gammon commented Jul 14, 2020

spalger commented Jul 14, 2020

spalger commented Jul 15, 2020

stacey-gammon commented Jul 15, 2020

spalger commented Jul 15, 2020

spalger commented Jul 15, 2020

stacey-gammon commented Jul 15, 2020

stacey-gammon left a comment

Choose a reason for hiding this comment

spalger commented Jul 15, 2020

spalger commented Jul 15, 2020

elasticmachine commented Jul 15, 2020

kibanamachine commented Jul 16, 2020

💚 Build Succeeded

Build metrics

History

mistic left a comment

Choose a reason for hiding this comment