Skip to content
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

Add best practices document about Hub manifests #43

Closed
mszostok opened this issue Nov 15, 2021 · 1 comment
Closed

Add best practices document about Hub manifests #43

mszostok opened this issue Nov 15, 2021 · 1 comment
Labels
area/community Relates to all community activities area/documentation Related to all activities around documentation area/hub-manifests Relates to Hub manifests enhancement New feature or request

Comments

@mszostok
Copy link
Member

Description

Add document about best practices for storing and creating Hub manifests.

Describe:

  • Hierarchy, e.g. prefer cap.interface.database.postgresql instead of cap.interface.postgres
  • How populator stores data e.g. generated path. Currently, they are calculated from dir structure (hierarchy).
  • How to deal with multiple revisions for the same Action. Currently, we use file names, e.g. install-0.0.1, install-0.2.1

Reason

"Consistent code is easier to maintain, is easier to rationalize, requires less cognitive overhead, and is easier to migrate or update as new conventions emerge or classes of bugs are fixed."

  • It's easier for us to review community PRs.
  • External contributors don't need to figure out the correct approach each time they create manifests.

Use cases

  • Content Developer - knows how to create quality, good content.
@mszostok mszostok added enhancement New feature or request area/community Relates to all community activities area/documentation Related to all activities around documentation area/hub-manifests Relates to Hub manifests labels Nov 15, 2021
@mszostok
Copy link
Member Author

Description moved to: #8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/community Relates to all community activities area/documentation Related to all activities around documentation area/hub-manifests Relates to Hub manifests enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant