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.

Sign up for GitHub

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 README and CODEOWNERS + disable plugin on 8.x #15

Merged
merged 2 commits into from
Jun 2, 2020
Merged

Add README and CODEOWNERS + disable plugin on 8.x #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e23508
Add plugin README and CODEOWNERS
cee-chen Jun 1, 2020
9009532
Temporarily disable plugin for 8.x
cee-chen Jun 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/CODEOWNERS
View file
Open in desktop
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,10 @@
# Design
**/*.scss @elastic/kibana-design

# Enterprise Search
/x-pack/plugins/enterprise_search/ @elastic/app-search-frontend @elastic/workplace-search-frontend
Copy link
Owner Author

Choose a reason for hiding this comment

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

Would appreciate some thoughts here - is it OK (for now?) if all CODEOWNER alerts go to both Workplace Search and App Search, or just App Search for now?

Alternatively, should I more painstakingly and granularly split up our file structure? Right now we have a lot of nested app_search folders that will have corresponding workplace_search siblings - do we want to eventually only alert AS FEDs for AS code, and WS for WS, etc.?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I could see the benefits for both. My personal opinion is to go with the current implementation but as soon as we start branching off and have code in workplace_search then we can diverge and go with the latter, more robust solution.

/x-pack/test/functional_enterprise_search/ @elastic/app-search-frontend @elastic/workplace-search-frontend

# Elasticsearch UI
/src/plugins/dev_tools/ @elastic/es-ui
/src/plugins/console/ @elastic/es-ui
Expand Down
25 changes: 25 additions & 0 deletions x-pack/plugins/enterprise_search/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Enterprise Search
Copy link
Owner Author

Choose a reason for hiding this comment

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

Would really appreciate any feedback/copy suggestions - wasn't totally sure what to write for this README file :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this is great personally.

Copy link

Choose a reason for hiding this comment

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

Ditto


## Overview

This plugin's goal is to provide a Kibana user interface to the Enterprise Search solution's products (App Search and Workplace Search). In its current MVP state, the plugin provides a basic engines overview from App Search with the goal of gathering user feedback and raising product awareness.

## Development

1. When developing locally, Enterprise Search should be running locally alongside Kibana on `localhost:3002`.
2. Update `config/kibana.dev.yml` with `enterpriseSearch.host: 'http://localhost:3002'`
3. For faster QA/development, run Enterprise Search on `elasticsearch-native` auth and log in as the `elastic` superuser on Kibana.

## Testing

### Unit tests

From `kibana-root-folder/x-pack`, run:

```bash
yarn test:jest plugins/enterprise_search
```

### E2E tests

See [our functional test runner README](../../test/functional_enterprise_search).
Copy link
Owner Author

Choose a reason for hiding this comment

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

This isn't in yet but will be after #6 is merged in

1 change: 1 addition & 0 deletions x-pack/plugins/enterprise_search/server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ export const plugin = (initializerContext: PluginInitializerContext) => {
};

export const configSchema = schema.object({
enabled: schema.boolean({ defaultValue: false }), // TODO: This plugin is disabled for master/8.x only. This line should be removed once Enterprise Search becomes 8.x compatible
host: schema.maybe(schema.string()),
});

Expand Down