github-community-projects / github-community-projects/safe-settings
Easier more clear instructions on what exactly is needed to deploy
- Dominant language
- JavaScript
- Stars
- 921
- Forks
- 226
- Avg merge
- 18h 3m
- Merged PRs (30d)
- 14
Description
it seems like the deploy instructions indicate that we have at least one required step:
- create an `admin` repo add settings yaml files.
Then it's not clear which of the following we have to choose:
- add some existing hosted `safe-settings` app to our org?
- simply run `docker run --rm -it -e APP_ID=*** -e GH_ORG=*** yadhav/safe-settings:2.0.9`
- fork the repo, clone it locally and go through all the pain in the ass stuff related to `npm install`, then develop some way to host this.
- fork the repo, clone it locally and decide to deploy it to some k8s cluster
- fork the repo, clone it locally and decide to deploy it to aws/serverless
Currently the documentation around deployment is very confusing when trying to understand what's needed depending on which of the above you want to do.
- does `.1` even exist?
- as in `.2` if we just want to run a docker container... can we just get away with specifying `-e ...`
Furthermore, there is contained in the documentation, language that seems to create confusion for first timers to github apps:
- talk about "manifest flow", indicate there are hard ways and easy ways to setup the app. when following the links to "manifest flow" we end up on a page that then talks about using `npx create...` which would have us creating another repo... so now we have three repos, the `admin` repo, the `safe-settings` repo we forked, and now this other repo that you're telling us to make because: "just follow the manifest flow"
really what I'd like, is to only have an `admin` repo and then just join an existing app to my org.
Contributor guide
Assessment
This issue has not been assessed yet.