History

Catherine Liu 63b76f2cd5 [Core UI] Kibana Overview Page (#75827 ) * Added kibana landing page Created kivana_overview plugin Removed test from home plugin Added CSS Fixed page header links Added news feed Fixed spacers between news items [Core UI] Kibana Overview Page Style Tweaks (#76712) Fixed link to index management Added solution cards to kibana landing page Added solution links Fixed ts errors Using publishReplay() to support multiple consumers in newsfeed plugin Added createNewsFeed$ to newsfeed plugin start Added tests Removed unnecessary export Hides overview link when other Kibana apps are not available Added icon to overview plugin Removed question mark from news feed title Updated plugin-list Fixed i18n errors Revert snapshot Updated getting started page copy Hide news feed when no news feed results Disables Kibana overview page when kibana apps are unavailable Updated snapshots Refactor to use KibanaContextProvider Fixed security tests Fixed newsfeed api test Moved overview_footer and overview_header to kibana-react plugin [Core UI] Kibana Overview Page Style Fixes (#78677) * Fixed a11y issues * Made newsfeed optional dep of kibana overview plugin * Removed duplicate license copy * Fixed management security test * Added toast to change default route button * Updated snapshots * Simplified toast notification * Fixed i18n error * Assigned kibana_overview plugin to Core UI in CODEOWNERS * Updated snapshots * Fix import * [Core UI] Kibana Overview Page Style Fixes, Part 3 (#78970) * fix overview cards not stretching height equally * change var name for better specificity * [Core UI] Kibana Overview Page Style Fixes, Part 4 (#79136) * Adds support for all newsfeed plugin config settings in createNewsFeed$ * Fixed type * Updated kibana overview page route * Fixed imports in page_footer and page_header * Update Kibana overview graphics (#79534) * Updated snapshots * Updated snapshots * Changes newsfeed endpoint to kibana analytics in kibana_overview plugin * Renamed components * Fixed overview page footer and header component class names * Removed extraneous files * Fixed import * Replaced SVGs with optimized SVGs * Fixed header and footer in home and kibana overview pages * Updated snapshots * Changed url_forwarding plugin appRoute * Fixed aria-labelledby value * Updated snapshots * Added base paths Co-authored-by: Michael Marcialis <michael.marcialis@elastic.co> Co-authored-by: Ryan Keairns <contactryank@gmail.com>		2020-10-06 09:13:31 -07:00
..
common	remove trailing slash in graph sample data links (#66358 )	2020-05-15 14:04:04 +02:00
public	[Core UI] Kibana Overview Page (#75827 )	2020-10-06 09:13:31 -07:00
server	Grouped features for space management (#74151 )	2020-09-18 12:30:59 -04:00
config.ts	Migrate vega and graph configs to new platform (#57011 )	2020-02-14 11:10:41 +01:00
kibana.json	[kbn/optimizer] implement "requiredBundles" property of KP plugins (#70911 )	2020-07-09 18:43:17 -07:00
README.md	[NP] Graph migration (#59409 )	2020-03-16 10:36:39 +03:00

README.md

Graph app

This is the main source folder of the Graph plugin. It contains all of the Kibana server and client source code. x-pack/test/functional/apps/graph contains additional functional tests.

Graph shows only up in the side bar if your server is running on a platinum or trial license. You can activate a trial license in Management > License Management.

Common commands

Run tests node x-pack/scripts/jest.js --watch plugins/graph
Run type check node scripts/type_check.js --project=x-pack/tsconfig.json
Run linter node scripts/eslint.js x-pack/plugins/graph
Run functional tests (make sure to stop dev server)
- Server cd x-pack && node ./scripts/functional_tests_server.js
- Tests cd x-pack && node ../scripts/functional_test_runner.js --config ./test/functional/config.js --grep=graph

Folder structure

Client `public/`

Currently most of the state handling is done by a central angular controller. This controller will be broken up into a redux/saga setup step by step.

angular/ contains all code using javascript and angular. Rewriting this code in typescript and react is currently ongoing. When the migration is finished, this folder will go away
components/ contains react components for various parts of the interface. Components can hold local UI state (e.g. current form data), everything else should be passed in from the caller. Styles should reside in a component-specific stylesheet
services/ contains functions that encapsule other parts of Kibana. Stateful dependencies are passed in from the outside. Components should not rely on services directly but have callbacks passed in. Once the migration to redux/saga is complete, only sagas will use services.
helpers/ contains side effect free helper functions that can be imported and used from components and services
state_management/ contains reducers, action creators, selectors and sagas. It also exports the central store creator
- Each file covers one functional area (e.g. handling of fields, handling of url templates...)
- Generally there is no file separation between reducers, action creators, selectors and sagas of the same functional area
- Sagas may contain cross-references between multiple functional areas (e.g. the loading saga sets fields and meta data). Because of this it is possible that circular imports occur. In this case the sagas are moved to a separate file <functional area>.sagas.ts.
types/ contains type definitions for unmigrated functions in angular/ and business objects
app.js is the central entrypoint of the app. It initializes router, state management and root components. This will become app.tsx when the migration is complete

Server `server/`

The Graph server is only forwarding requests to Elasticsearch API and contains very little logic. It will be rewritten soon.