github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Graph] clear legacy docs (#111083)

Browse source 
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Dmitry Tomashevich 2021-09-07 10:34:19 +03:00 • committed by GitHub
parent e2c6a039f6
commit 9f950781a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 9 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

10
x-pack/plugins/graph/README.md
View file

@ -17,18 +17,18 @@ Graph shows only up in the side bar if your server is running on a platinum or t
### 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.
Currently state handled by react/redux/saga and the core mutable `GraphWorkspace` instance, which managing the nodes and edges state. It should be rewritten in typescript and integrated into redux store.
* `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
* `apps/` contains all graph app routes
* `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.
* `services/` contains the core workspace logic and 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
* `types/` contains type definitions for unmigrated `GraphWorkspace` methods
* `router.tsx` is the central entrypoint of the app
### Server `server/`