Arranger is a server. The UI Components are a powerful set of tools we provide that make it desirable and easier to use Arranger with React UIs. As such, all our documentation should frame Arranger as a standalone back-end application, with a set of great supporting tools.
Documentation should be divided in three angles, based on their target audiences:
"Operation" for those seeking to spin up Arranger on its own. This angle will introduce most of the content for how the server works, its requirements, etc.
"Integration" will be better geared towards those seeking to use Arranger in a more "customised" manner, e.g. extended as a middleware or a dependency within an existing ExpressJS API. It will also introduce the UI components, and how those interact with Arranger.
"Contribution" will explain more in detail how to run Arranger from source code, what we expect in a PR, etc.
Note: The weird numbering in the following summaries is to compensate for poor markdown indentation.
Operation Docs:
"How to install and run Arranger as a stand-alone product"
How to Install Stand Alone Server
Configuration of server. Two types of data source need to be described:
2.1. Maestro data using standard analysis and file -centric indices
2.2. Custom data structure from ES Index
How arranger works with ES Mappings (keyword vs string, boolean, date, number, supported types etc.)
Changes from V2
3.1. Log of changes
Important things to update
3.2. Migration guide from V2
Integration Docs:
"How to bring Arranger into your own projects"
SQONs
UI Components "Using Arranger with a React App"
2.1 Configuration of UI Components
General Display Properties
Table
Facets
2.2 Storybook
Server API documentation
2.1 Integrating with express server
2.2 Integrating with federated GQL
Important overall change of tone and style:
Arranger is a server. The UI Components are a powerful set of tools we provide that make it desirable and easier to use Arranger with React UIs. As such, all our documentation should frame Arranger as a standalone back-end application, with a set of great supporting tools.
Documentation should be divided in three angles, based on their target audiences:
Note: The weird numbering in the following summaries is to compensate for poor markdown indentation.
Operation Docs:
"How to install and run Arranger as a stand-alone product"
How to Install Stand Alone Server
Configuration of server. Two types of data source need to be described: 2.1. Maestro data using standard
analysisandfile-centric indices 2.2. Custom data structure from ES IndexChanges from V2 3.1. Log of changes
Integration Docs:
"How to bring Arranger into your own projects"
SQONs
UI Components "Using Arranger with a React App" 2.1 Configuration of UI Components
Server API documentation 2.1 Integrating with express server 2.2 Integrating with federated GQL
Contribution Docs:
"How to develop arranger source code"
For V3 Release
Required: