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

Enhance Mozilla SOPS Integration docs #712

Open
asaikali opened this issue Oct 22, 2023 · 2 comments
Open

Enhance Mozilla SOPS Integration docs #712

asaikali opened this issue Oct 22, 2023 · 2 comments
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request

Comments

@asaikali
Copy link

The Integration with Mozilla's sops](https://carvel.dev/kapp-controller/docs/v0.48.x/sops/) docs jumps straight into a how-to instructions with no high level explanation of how the the integration works. The docs currently assume the reader already knows kapp-controller and Mozilla SOPS.

The SOPS doc page should have a small section added at the start of the doc that explains at a high level how the integration work. parts of this section are:

  1. brief explanation of mozilla sops
  2. brief explanation of the fetch / template / deploy life cycle of kapp-controller and where SOPS integrates into the lifecyle
  3. Steps of the workflow for adding a secret via SOPS, the steps should not explain the how just the main steps. The rest of the doc will explain how to accomplish the steps. We are trying to help the users understand the sequence of steps they need to go through.
  4. Steps of the workflow for updating a secret after it has been added, only high level steps not how to do it. The how should be explained in the rest of the doc.
@asaikali asaikali added carvel-triage enhancement This issue is a feature request labels Oct 22, 2023
Copy link

github-actions bot commented Dec 2, 2023

This issue is being marked as stale due to a long period of inactivity and will be closed in 5 days if there is no response.

@github-actions github-actions bot added the stale This issue has had no activity for a while and will be closed soon label Dec 2, 2023
@praveenrewar praveenrewar added discussion This issue is not a bug or feature and a conversation is needed to find an appropriate resolution and removed stale This issue has had no activity for a while and will be closed soon labels Dec 5, 2023
@renuy renuy transferred this issue from carvel-dev/kapp-controller Jan 9, 2024
@renuy renuy added carvel accepted This issue should be considered for future work and that the triage process has been completed and removed discussion This issue is not a bug or feature and a conversation is needed to find an appropriate resolution labels Jan 9, 2024
@renuy
Copy link
Contributor

renuy commented Jan 9, 2024

Moving issue to Carvel repo for changes to documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request
Projects
Status: Prioritized Backlog
Development

No branches or pull requests

3 participants