[Enterprise Search] Update README/description (#105151) (#105280)

* Update plugin README with beta copy & fancier product info

* Update API dev docs plugin description punctuation

* Update README dev section

- Remote reference to native auth - no longer applicable in 7.14
- Add reference to Getting Started guide (Elastic only)

* Run node scripts/build_plugin_list_docs to update https://www.elastic.co/guide/en/kibana/master/plugin-list.html

* Add link to main Kibana README
- which should link out to their contributing docs

Co-authored-by: Constance <constancecchen@users.noreply.github.com>
This commit is contained in:
Kibana Machine 2021-07-12 16:03:42 -04:00 committed by GitHub
parent 12c9853418
commit f850cd737c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 20 additions and 6 deletions

View file

@ -385,7 +385,7 @@ security and spaces filtering as well as performing audit logging.
|{kib-repo}blob/{branch}/x-pack/plugins/enterprise_search/README.md[enterpriseSearch]
|This plugin's goal is to provide a Kibana user interface to the Enterprise Search solution's products (App Search and Workplace Search). In it's current MVP state, the plugin provides the following with the goal of gathering user feedback and raising product awareness:
|This plugin provides beta Kibana user interfaces for managing the Enterprise Search solution and its products, App Search and Workplace Search.
|{kib-repo}blob/{branch}/x-pack/plugins/event_log/README.md[eventLog]

View file

@ -2,16 +2,30 @@
## 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 it's current MVP state, the plugin provides the following with the goal of gathering user feedback and raising product awareness:
This plugin provides beta Kibana user interfaces for managing the Enterprise Search solution and its products, App Search and Workplace Search.
- **App Search:** A basic engines overview with links into the product.
- **Workplace Search:** A simple app overview with basic statistics, links to the sources, users (if standard auth), and product settings.
> :warning: The Kibana interface for Enterprise Search is a beta feature. It is subject to change and is not covered by the same level of support as generally available features. This interface will become the sole management panel for Enterprise Search with the 8.0 release. Until then, the standalone Enterprise Search UI remains available and supported.
### App Search
<img src="./public/applications/enterprise_search/assets/app_search.png" width="400" height="255">
Add rich, relevant search to your apps and websites. https://www.elastic.co/app-search/
### Workplace Search
<img src="./public/applications/enterprise_search/assets/workplace_search.png" width="400" height="255">
Unify all your team's content into a personalized search experience. https://www.elastic.co/workplace-search/
## 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](https://www.elastic.co/guide/en/app-search/current/security-and-users.html#app-search-self-managed-security-and-user-management-elasticsearch-native-realm) and log in as the `elastic` superuser on Kibana.
Problems? If you're an Elastic Enterprise Search engineer, please reach out to @elastic/enterprise-search-frontend for questions or our in-depth Getting Started developer guide.
Don't forget to read Kibana's [contributing documentation](https://github.com/elastic/kibana/#building-and-running-kibana-andor-contributing-code) and developer guides for more general info on the Kibana ecosystem.
### Kea

View file

@ -12,5 +12,5 @@
"name": "Enterprise Search",
"githubTeam": "enterprise-search-frontend"
},
"description": "Adds dashboards for discovering and managing Enterprise Search products"
"description": "Adds dashboards for discovering and managing Enterprise Search products."
}