-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: how to use layers #548
base: master
Are you sure you want to change the base?
Conversation
ENV: dev | ||
``` | ||
|
||
`002-env-override-test.yaml`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be 003-env-override-test.yaml shouldn't it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idea is that override-test
will only be put into the test env and override-dev
will only be put in the dev env. So it doesn't matter if they have same numeric prefixes because they will not be put into the same env.
. | ||
└── layers | ||
├── 001-base-layer.yaml | ||
└── 002-env-override-test.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
003-env-override-test.yaml ?
Thanks @IronCore864, this new doc is a helpful summary of how to use layers! I've added some suggestions and questions about specific parts. One other observation - In the intro, the doc mentions three benefits:
Of these, it seems that we only illustrate 1 and 3. Is that because 2 is pretty similar to 1 in approach? I think it would be nice if we could match up each benefit with a corresponding section. For example, at the end of the first bullet, we could say:
And similarly for the other benefits. We could either add a dedicated section to show how to define one set of configurations per environment. Or if it's really essentially the same as how to organize services into logical groups, at the end of benefit 2 we could say something like:
What do you think? |
Docs: How to use layers.
As previously discussed, the layers reference doc is removed and refactored into a how-to.
Preview: https://canonical-pebble--548.com.readthedocs.build/en/548/how-to/use-layers/