Project layout conventions to enable doc auto-generation and service auto discovery #43
Description
Maven already imposes its own project layout conventions
In a similar spirit, I propose taking advantage of conventions that we have already informally adopted to automate certain useful cross-component documentation, and to enable cross-component scripting (emap.sh script or similar) to discover which Emap components exist and their status and so on.
Main one I can think of is checking for any file matching the glob *-envs.EXAMPLE and bringing this into a config howto document. I suspect github actions can do this. Scripts could take advantage of this by copying EXAMPLE files to the config dir for your instance if they don't exist, diffing your current version against the example files to see what you've changed from default values, that sort of thing.
I'm sure in the past I could think of some uses for standard operations or data that might belong in an api directory in each component's root. A lot of this is covered by standard git/maven/whatever commands, and I've forgotten what my great ideas were :) but maybe this will give someone else an idea!