Skip to content
This repository has been archived by the owner on Oct 12, 2023. It is now read-only.

'User guide' docs: the whats/whys/hows of ApplicationSet controller #84

Closed
jgwest opened this issue Dec 17, 2020 · 0 comments · Fixed by #117
Closed

'User guide' docs: the whats/whys/hows of ApplicationSet controller #84

jgwest opened this issue Dec 17, 2020 · 0 comments · Fixed by #117
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jgwest
Copy link
Member

jgwest commented Dec 17, 2020

Write new documentation content, similar to Argo CD's user guide, on how to use ApplicationSet controller.

To include in the docs:

The design proposal is well written, and that content could likely be used for new user-facing documentation of:

  • What ApplicationSet is
    • still experimental, feedback welcome
  • Why does it exist, what problem is ApplicationSet controller looking to solve, versus Argo CD proper
    • scenarios
      • cluster add-ons
      • monorepo
      • self-service
    • issues with the app-of-apps pattern for these use cases
  • How ApplicationSet works
    • what are generators? (general introduction)
    • what are the template fields? (general introduction, eg what are src, dest for)
    • how it interacts with Argo CD proper
    • Note: Don't need to document any specific, detailed examples of the generators as part of this issue, they will be addressed separately as part of this issue

Docs to be written in the same style as Argo CD:

  • Create a docs/ in ApplicationSet repo, docs to be written in markdown
  • Docs to follow the defacto 'style guide' of the existing Argo CD user guide (eg same use of # and ## to denote sections and subsections, and following any other desired traits/idioms of those existing docs)
  • This issue is for writing the content only, no need to setup 'rendering markdown to HTML' step as part of this.
@jgwest jgwest changed the title 'User guide' docs: how to use it: the whats/whys/hows of ApplicationSet controller 'User guide' docs: the whats/whys/hows of ApplicationSet controller Dec 17, 2020
@jgwest jgwest added the documentation Improvements or additions to documentation label Jan 12, 2021
@jgwest jgwest added this to the Milestone 1 milestone Jan 12, 2021
@jgwest jgwest self-assigned this Jan 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
1 participant