[NXP-29894] Add README to addons new repositories - Nuxeo Issue Tracker

XML

Word

Printable

Details

Type: Task
Status: Resolved
Priority: Major
Resolution: Fixed
Affects Version/s: None
Fix Version/s: 11.x
Component/s: Aspera Connector, Glacier, Retention

Tags:
- nxApps
Sprint:
nxApps 2020 Cycle 12

Description

Since the decoupling the Cold Storage and Retention Management that those addons are living in seperated repos from Platform and Web UI.

It is important to have a README file in each of them in order to state:

Functional purpose and context;
Sub modules organization and meaning (since we have multiple modules: core, web, etc.)
Build
- How to compile and install;
- CI (e.g. reference to our pipeline);
Potencial configurations (e.g. Aspera has a lot of AWS stuff, as Cold Storage. Retention has different compliance modes);
UI dev flow, according to the new building and dev experience efforts
- How we sync with Web UI so we can have an integrated flow
Test
- How to run tests
Versioning

We can take inspiration from other Nuxeo repositories and also from external ones. But, at the end of the day, the important part is to provide all the information needed so anyone can interact easily with the addon and its code.