Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a new hello world plugin and adjust the welcome message. #107789

Merged

Conversation

stacey-gammon
Copy link
Contributor

@stacey-gammon stacey-gammon commented Aug 5, 2021

I've gotten some feedback on the Developer Guide that the order of the documentation doesn't work well because it jumps into advanced concepts too quickly.

I decided to try to follow the React Docs which has a hello world plugin as one of the first things a user will read. I also created a Contributing section, as they have, and moved some of the Getting Started content into that.

Before:
Screen Shot 2021-08-05 at 1 58 34 PM

After:
Screen Shot 2021-08-05 at 1 53 18 PM

I'm also considering renaming tutorials to Advanced Guides ala React as well.

@stacey-gammon stacey-gammon force-pushed the 2021-08-03-hello-world-app branch from b2fbb96 to f9fbaf5 Compare August 5, 2021 17:53
@stacey-gammon stacey-gammon marked this pull request as ready for review August 6, 2021 12:00
Copy link
Member

@ppisljar ppisljar left a comment

Choose a reason for hiding this comment

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

i like the new menu structure

dev_docs/getting_started/hello_world_plugin.mdx Outdated Show resolved Hide resolved
dev_docs/getting_started/hello_world_plugin.mdx Outdated Show resolved Hide resolved
dev_docs/getting_started/hello_world_plugin.mdx Outdated Show resolved Hide resolved
dev_docs/getting_started/hello_world_plugin.mdx Outdated Show resolved Hide resolved
@stacey-gammon stacey-gammon added release_note:skip Skip the PR/issue when compiling release notes v7.15.0 v8.0.0 labels Aug 9, 2021
@kibanamachine
Copy link
Contributor

💛 Build succeeded, but was flaky


Test Failures

Kibana Pipeline / general / X-Pack Detection Engine API Integration Tests.x-pack/test/detection_engine_api_integration/security_and_spaces/tests/exception_operators_data_types/text·ts.detection engine api security and spaces enabled Detection exceptions data types and operators Rule exception operators for data type text "is not" operator will return 0 results if it cannot find what it is excluding

Link to Jenkins

Standard Out

Failed Tests Reporter:
  - Test has failed 1 times on tracked branches: https://github.com/elastic/kibana/issues/107911

[00:00:00]       │
[00:00:00]         └-: detection engine api security and spaces enabled
[00:00:00]           └-> "before all" hook in "detection engine api security and spaces enabled"
[00:00:00]           └-: 
[00:00:00]             └-> "before all" hook in ""
[00:00:00]             └-: Detection exceptions data types and operators
[00:00:00]               └-> "before all" hook in "Detection exceptions data types and operators"
[00:00:00]               └-: 
[00:00:00]                 └-> "before all" hook in ""
[00:00:00]                 └-: Rule exception operators for data type text
[00:00:00]                   └-> "before all" hook in "Rule exception operators for data type text"
[00:00:00]                   └-: "is not" operator
[00:00:00]                     └-> "before all" hook for "will return 0 results if it cannot find what it is excluding"
[00:00:00]                     └-> will return 0 results if it cannot find what it is excluding
[00:00:00]                       └-> "before each" hook: global before each for "will return 0 results if it cannot find what it is excluding"
[00:00:00]                       └-> "before each" hook for "will return 0 results if it cannot find what it is excluding"
[00:00:00]                         │ info [o.e.x.i.a.TransportPutLifecycleAction] [node-01] adding index lifecycle policy [.siem-signals-default-migration-cleanup]
[00:00:00]                         │ info [o.e.x.i.a.TransportPutLifecycleAction] [node-01] adding index lifecycle policy [.siem-signals-default]
[00:00:00]                         │ info [o.e.c.m.MetadataIndexTemplateService] [node-01] adding index template [.siem-signals-default] for index patterns [.siem-signals-default-*]
[00:00:00]                         │ info [o.e.c.m.MetadataCreateIndexService] [node-01] [.siem-signals-default-000001] creating index, cause [api], templates [.siem-signals-default], shards [1]/[1]
[00:00:00]                         │ info [o.e.x.i.IndexLifecycleTransition] [node-01] moving index [.siem-signals-default-000001] from [null] to [{"phase":"new","action":"complete","name":"complete"}] in policy [.siem-signals-default]
[00:00:00]                         │ info [o.e.x.i.IndexLifecycleTransition] [node-01] moving index [.siem-signals-default-000001] from [{"phase":"new","action":"complete","name":"complete"}] to [{"phase":"hot","action":"unfollow","name":"branch-check-unfollow-prerequisites"}] in policy [.siem-signals-default]
[00:00:00]                         │ info [o.e.x.i.a.TransportPutLifecycleAction] [node-01] adding index lifecycle policy [.lists-default]
[00:00:00]                         │ info [o.e.x.i.IndexLifecycleTransition] [node-01] moving index [.siem-signals-default-000001] from [{"phase":"hot","action":"unfollow","name":"branch-check-unfollow-prerequisites"}] to [{"phase":"hot","action":"rollover","name":"check-rollover-ready"}] in policy [.siem-signals-default]
[00:00:00]                         │ info [o.e.x.i.a.TransportPutLifecycleAction] [node-01] adding index lifecycle policy [.items-default]
[00:00:00]                         │ info [o.e.c.m.MetadataIndexTemplateService] [node-01] adding template [.lists-default] for index patterns [.lists-default-*]
[00:00:00]                         │ info [o.e.c.m.MetadataIndexTemplateService] [node-01] adding template [.items-default] for index patterns [.items-default-*]
[00:00:00]                         │ info [o.e.c.m.MetadataCreateIndexService] [node-01] [.lists-default-000001] creating index, cause [api], templates [.lists-default], shards [1]/[1]
[00:00:00]                         │ info [o.e.x.i.IndexLifecycleTransition] [node-01] moving index [.lists-default-000001] from [null] to [{"phase":"new","action":"complete","name":"complete"}] in policy [.lists-default]
[00:00:00]                         │ info [o.e.c.m.MetadataCreateIndexService] [node-01] [.items-default-000001] creating index, cause [api], templates [.items-default], shards [1]/[1]
[00:00:00]                         │ info [o.e.x.i.IndexLifecycleTransition] [node-01] moving index [.lists-default-000001] from [{"phase":"new","action":"complete","name":"complete"}] to [{"phase":"hot","action":"unfollow","name":"branch-check-unfollow-prerequisites"}] in policy [.lists-default]
[00:00:00]                         │ info [x-pack/test/functional/es_archives/rule_exceptions/text] Loading "mappings.json"
[00:00:00]                         │ info [x-pack/test/functional/es_archives/rule_exceptions/text] Loading "data.json"
[00:00:00]                         │ info [o.e.x.i.IndexLifecycleTransition] [node-01] moving index [.items-default-000001] from [null] to [{"phase":"new","action":"complete","name":"complete"}] in policy [.items-default]
[00:00:00]                         │ info [o.e.x.i.IndexLifecycleTransition] [node-01] moving index [.lists-default-000001] from [{"phase":"hot","action":"unfollow","name":"branch-check-unfollow-prerequisites"}] to [{"phase":"hot","action":"rollover","name":"check-rollover-ready"}] in policy [.lists-default]
[00:00:00]                         │ info [o.e.c.m.MetadataCreateIndexService] [node-01] [text] creating index, cause [api], templates [], shards [1]/[1]
[00:00:01]                         │ info [x-pack/test/functional/es_archives/rule_exceptions/text] Created index "text"
[00:00:01]                         │ debg [x-pack/test/functional/es_archives/rule_exceptions/text] "text" settings {"index":{"number_of_replicas":"1","number_of_shards":"1"}}
[00:00:01]                         │ info [o.e.x.i.IndexLifecycleTransition] [node-01] moving index [.items-default-000001] from [{"phase":"new","action":"complete","name":"complete"}] to [{"phase":"hot","action":"unfollow","name":"branch-check-unfollow-prerequisites"}] in policy [.items-default]
[00:00:01]                         │ info [x-pack/test/functional/es_archives/rule_exceptions/text] Indexed 4 docs into "text"
[00:00:01]                         │ info [o.e.x.i.IndexLifecycleTransition] [node-01] moving index [.items-default-000001] from [{"phase":"hot","action":"unfollow","name":"branch-check-unfollow-prerequisites"}] to [{"phase":"hot","action":"rollover","name":"check-rollover-ready"}] in policy [.items-default]
[00:00:01]                         │ info [x-pack/test/functional/es_archives/rule_exceptions/text_no_spaces] Loading "mappings.json"
[00:00:01]                         │ info [x-pack/test/functional/es_archives/rule_exceptions/text_no_spaces] Loading "data.json"
[00:00:01]                         │ info [o.e.c.m.MetadataCreateIndexService] [node-01] [text_no_spaces] creating index, cause [api], templates [], shards [1]/[1]
[00:00:01]                         │ info [x-pack/test/functional/es_archives/rule_exceptions/text_no_spaces] Created index "text_no_spaces"
[00:00:01]                         │ debg [x-pack/test/functional/es_archives/rule_exceptions/text_no_spaces] "text_no_spaces" settings {"index":{"number_of_replicas":"1","number_of_shards":"1"}}
[00:00:01]                         │ info [x-pack/test/functional/es_archives/rule_exceptions/text_no_spaces] Indexed 4 docs into "text_no_spaces"
[00:00:01]                       │ info [o.e.c.m.MetadataMappingService] [node-01] [.kibana_8.0.0_001/S9jkMs57RMqoAPuensNQwg] update_mapping [_doc]
[00:00:06]                       │ info [o.e.c.m.MetadataMappingService] [node-01] [.kibana_8.0.0_001/S9jkMs57RMqoAPuensNQwg] update_mapping [_doc]
[00:00:07]                       │ info [o.e.c.m.MetadataMappingService] [node-01] [.kibana_8.0.0_001/S9jkMs57RMqoAPuensNQwg] update_mapping [_doc]
[00:00:10]                       │ proc [kibana]   log   [16:47:21.084] [info][eventLog][plugins] event logged: {"@timestamp":"2021-08-09T16:47:21.083Z","event":{"provider":"alerting","action":"execute-start","kind":"alert","category":["siem"],"start":"2021-08-09T16:47:21.083Z"},"kibana":{"saved_objects":[{"rel":"primary","type":"alert","id":"744c4000-f931-11eb-8d02-2f772bde41c7","type_id":"siem.signals"}],"task":{"scheduled":"2021-08-09T16:47:20.537Z","schedule_delay":546000000},"server_uuid":"5b2de169-2785-441b-ae8c-186a1936b17d"},"rule":{"id":"744c4000-f931-11eb-8d02-2f772bde41c7","license":"basic","category":"siem.signals","ruleset":"siem"},"message":"alert execution start: \"744c4000-f931-11eb-8d02-2f772bde41c7\"","ecs":{"version":"1.8.0"}}
[00:00:11]                       │ proc [kibana]   log   [16:47:21.608] [info][eventLog][plugins] event logged: {"@timestamp":"2021-08-09T16:47:21.083Z","event":{"provider":"alerting","action":"execute","kind":"alert","category":["siem"],"start":"2021-08-09T16:47:21.083Z","outcome":"failure","end":"2021-08-09T16:47:21.608Z","duration":525000000,"reason":"execute"},"kibana":{"saved_objects":[{"rel":"primary","type":"alert","id":"744c4000-f931-11eb-8d02-2f772bde41c7","type_id":"siem.signals"}],"task":{"scheduled":"2021-08-09T16:47:20.537Z","schedule_delay":546000000},"alerting":{"status":"error"},"server_uuid":"5b2de169-2785-441b-ae8c-186a1936b17d"},"rule":{"id":"744c4000-f931-11eb-8d02-2f772bde41c7","license":"basic","category":"siem.signals","ruleset":"siem"},"message":"alert execution failure: siem.signals:744c4000-f931-11eb-8d02-2f772bde41c7: 'Signal Testing Query'","error":{"message":"[siem-detection-engine-rule-status:771daf80-f931-11eb-8d02-2f772bde41c7]: version conflict, required seqNo [18], primary term [1]. current document has seqNo [19] and primary term [1]: version_conflict_engine_exception: [version_conflict_engine_exception] Reason: [siem-detection-engine-rule-status:771daf80-f931-11eb-8d02-2f772bde41c7]: version conflict, required seqNo [18], primary term [1]. current document has seqNo [19] and primary term [1]"},"ecs":{"version":"1.8.0"}}
[00:00:11]                       │ proc [kibana]   log   [16:47:21.619] [error][alerting][plugins] Executing Alert default:siem.signals:744c4000-f931-11eb-8d02-2f772bde41c7 has resulted in Error: [siem-detection-engine-rule-status:771daf80-f931-11eb-8d02-2f772bde41c7]: version conflict, required seqNo [18], primary term [1]. current document has seqNo [19] and primary term [1]: version_conflict_engine_exception: [version_conflict_engine_exception] Reason: [siem-detection-engine-rule-status:771daf80-f931-11eb-8d02-2f772bde41c7]: version conflict, required seqNo [18], primary term [1]. current document has seqNo [19] and primary term [1], caused by: ""
[00:01:35]                       └- ✖ fail: detection engine api security and spaces enabled  Detection exceptions data types and operators  Rule exception operators for data type text "is not" operator will return 0 results if it cannot find what it is excluding
[00:01:35]                       │      Error: timed out waiting for function condition to be true within waitForRuleSuccessOrStatus
[00:01:35]                       │       at /dev/shm/workspace/parallel/12/kibana/x-pack/test/detection_engine_api_integration/utils.ts:785:9
[00:01:35]                       │ 
[00:01:35]                       │ 

Stack Trace

Error: timed out waiting for function condition to be true within waitForRuleSuccessOrStatus
    at /dev/shm/workspace/parallel/12/kibana/x-pack/test/detection_engine_api_integration/utils.ts:785:9

Metrics [docs]

✅ unchanged

History

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

@stacey-gammon stacey-gammon merged commit 2230c03 into elastic:master Aug 9, 2021
@stacey-gammon stacey-gammon added the auto-backport Deprecated - use backport:version if exact versions are needed label Aug 9, 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 107789

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 10, 2021
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 107789 or prevent reminders by adding the backport:skip label.

stacey-gammon added a commit to stacey-gammon/kibana that referenced this pull request Aug 11, 2021
…#107789)

* Add a new hello world plugin and adjust the welcome message.

* update and move files

* Update CODEOWNERS

* add a tsconfig.json file

* update tsconfig.json

* fix type check

* address code review comments
# Conflicts:
#	.github/CODEOWNERS
stacey-gammon added a commit that referenced this pull request Aug 11, 2021
…107789) (#108182)

* Add a new hello world plugin and adjust the welcome message. (#107789)

* Add a new hello world plugin and adjust the welcome message.

* update and move files

* Update CODEOWNERS

* add a tsconfig.json file

* update tsconfig.json

* fix type check

* address code review comments
# Conflicts:
#	.github/CODEOWNERS

* Update tsconfig.json

Need to account for #108139

* Update tsconfig.json

Needed to add references
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 11, 2021
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.15.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants