Problem
The current organization of documentation in the repo is fragmented and difficult to navigate for users new to Antalya. Users should be able to easily find set up instructions for different environments and individual components like ice-rest-catalog.
Proposed solution
The repository README could clearly link to a new "Setup Guide" (docs/set-up.md) file that directs users to the existing READMEs for setting up each environment. The "Setup Guide" would contain a high level overview on the components and use cases of each Antalya environment (i.e. Docker vs MiniKube vs EKS).
New markdown links could be added between existing README files for improved navigation throughout the repo.
Problem
The current organization of documentation in the repo is fragmented and difficult to navigate for users new to Antalya. Users should be able to easily find set up instructions for different environments and individual components like ice-rest-catalog.
Proposed solution
The repository README could clearly link to a new "Setup Guide" (
docs/set-up.md) file that directs users to the existing READMEs for setting up each environment. The "Setup Guide" would contain a high level overview on the components and use cases of each Antalya environment (i.e. Docker vs MiniKube vs EKS).New markdown links could be added between existing README files for improved navigation throughout the repo.