Skip to content
This repository has been archived by the owner on Jul 15, 2024. It is now read-only.

Expand on existing developer docs: how to setup dev env and how to run ApplicationSet controller on local machine #74

Closed
jgwest opened this issue Dec 17, 2020 · 2 comments
Closed

Expand on existing developer docs: how to setup dev env and how to run ApplicationSet controller on local machine #74

jgwest opened this issue Dec 17, 2020 · 2 comments
Assignees
@jgwest
Labels
documentation Improvements or additions to documentation
Milestone
0.1.0 - Milestone 1

Comments

@jgwest
Copy link
Member

jgwest commented Dec 17, 2020

ApplicationSet has a short section on how to develop it, in the parent readme:
https://github.com/argoproj-labs/applicationset#development-instructions

We should expand on this:

  • How to run ApplicationSet controller on your local machine from CLI (rather than run it as a container image on k8s, as the docs currently suggest)
  • How to setup a local Argo CD dev environment (just need to point to relevant Argo CD docs, can probably steal the content from here)
  • Expand on the The following assumes you have: steps that are here, by adding a bit more detail on how to do a k8s deploy of ApplicationSet controller (IMHO the 3 steps are a bit too general, if you are not fully familiar with Argo CD and/or ApplicationSet)

Either on the root README.md page, or as a separate doc page linked from the README.
@jgwest jgwest mentioned this issue Dec 17, 2020
Open
@jgwest
Copy link
Member Author

jgwest commented Jan 8, 2021

I've started work on this.

jgwest added a commit to jgwest/applicationset that referenced this issue Jan 11, 2021
@jgwest
Expand on existing developer docs: how to setup dev env and how to ru…
a548b55 
…n ApplicationSet controller on local machine (argoproj#74)
jgwest added a commit to jgwest/applicationset that referenced this issue Jan 11, 2021
@jgwest
Expand on existing developer docs: how to setup dev env and how to ru…
3bcd494 
…n ApplicationSet controller on local machine (argoproj#74)
@jgwest jgwest mentioned this issue Jan 11, 2021
Merged
xianlubird pushed a commit that referenced this issue Jan 12, 2021
@jgwest
Expand on existing developer docs: how to setup dev env and how to ru…
6c46c12 
…n ApplicationSet controller on local machine (#74) (#90)

* Expand on existing developer docs: how to setup dev env and how to run ApplicationSet controller on local machine (#74)

* Expand on existing developer docs: how to setup dev env and how to run ApplicationSet controller on local machine (#74)
@jgwest jgwest self-assigned this Jan 12, 2021
@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
Copy link
Member Author

jgwest commented Jan 13, 2021

Closing as done.

@jgwest jgwest closed this as completed Jan 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jgwest jgwest

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.1.0 - Milestone 1
Development

No branches or pull requests
1 participant
@jgwest