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.

Sign up for GitHub

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

Jump to bottom

Write guide for simple repo/directory structure #3503

Closed
10 tasks
Callisto13 opened this issue Mar 13, 2023 · 1 comment
Closed
10 tasks

Write guide for simple repo/directory structure #3503

Callisto13 opened this issue Mar 13, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation user-guide Improvements to docs at https://docs.gitops.weave.works/

Comments

@Callisto13
Copy link
Contributor

Callisto13 commented Mar 13, 2023 •
edited by lasomethingsomething
Loading

As a WG User who has a management cluster, 2+ leaf clusters, and a handful (~20-50) of objects (apps/kustomizations/etc), I would like to know about how to create a simple repo/directory structure and why I'd do that.

Acceptance criteria:

  • The guide explains what problem the user can solve, why the user wants to solve that problem, and a summary of the outcome
  • Provides a complete list of prerequisites:
    • what state does the cluster need to be in?
    • do I need to have set anything up outside the cluster?
    • is this guide for a development environment? or do i need a "real" env with network/dns/routing etc?
  • An intuitive journey through the steps
  • Yaml/command output is collapsed to avoid saturating the page
  • Screenshots with readable text, if applicable
  • Every copy-pastable command is tested
  • An example repository that shows the completed solution, which users can easily clone and apply to their cluster if they want
@Callisto13 Callisto13 added the documentation Improvements or additions to documentation label Mar 13, 2023
@lasomethingsomething lasomethingsomething added the user-guide Improvements to docs at https://docs.gitops.weave.works/ label May 24, 2023
@lasomethingsomething lasomethingsomething changed the title docs: Write guide for simple repo/directory structure Write guide for simple repo/directory structure May 24, 2023
@lasomethingsomething
Copy link
Contributor

Moved user story to #3504

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation user-guide Improvements to docs at https://docs.gitops.weave.works/
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lasomethingsomething @Callisto13