bird-house / birdhouse-deploy

Scripts and configurations to deploy the various birds and servers required for a full-fledged production platform
https://birdhouse-deploy.readthedocs.io/en/latest/
Apache License 2.0
4 stars 6 forks source link

:books: [Documentation]: improve tagging criteria #476

Open mishaschwartz opened 3 days ago

mishaschwartz commented 3 days ago

Description

The tagging criteria when creating a new release mostly refers to how components interact, not how they impact the end-user:

https://github.com/bird-house/birdhouse-deploy/blob/1528ba14db5c476fca11033a97f7df99b74b0fc4/birdhouse/README.rst?plain=1#L324-L336

This is fine but a bit ambiguous we need to also consider how these changes affect users. I suggest changing the language to:

I think we should also add in some language about requiring an addition to the migration guide for all major and minor updates.

References

Information Value
Server/Platform URL all
Related issues/PR #475
Related documentation - https://github.com/bird-house/birdhouse-deploy/blob/master/birdhouse/README.rst#tagging-policy
- https://github.com/bird-house/birdhouse-deploy/blob/master/docs/source/migration_guide.rst
tlvu commented 3 days ago

I agree with the suggestion. Also we should review any configs that is not generic (like Ouranos Jupyter specific image in https://github.com/bird-house/birdhouse-deploy/pull/475#issuecomment-2483949136) and if we can not make them optional, not enabled by default, we document them clearly they are not generic.

The components to review are those that were previously enable by default and now they are not. The default values of their configs might be able to change to something more generic.