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

End-user facing scripts should be easily identifiable #166

Closed
glennmusa opened this issue Apr 21, 2021 · 0 comments · Fixed by #204
Closed

End-user facing scripts should be easily identifiable #166

glennmusa opened this issue Apr 21, 2021 · 0 comments · Fixed by #204
Assignees
Labels
core New feature or request

Comments

@glennmusa
Copy link
Contributor

Benefit/Result/Outcome
When I clone the repo, I should fall into some predictable place to run the end-user automation

Description
Today, I can think of these scripts that are purpose-built for end users:

  • src/deploy.sh
  • src/clean.sh
  • scripts/setup_ezdeploy.sh

and these scripts are referenced in docs and helpful:

  • scripts/mlz_tf_setup.sh
  • scripts/config/config_clean.sh
  • scripts/setup_ezdeploy_local.sh
  • scripts/init_terraform.sh
  • scripts/apply_terraform.sh
  • scripts/destroy_terraform.sh

Acceptance Criteria

  • When I clone the repo, it's obvious to me what set of scripts get me started
  • When I clone the repo, it's obvious to me what set of scripts are helpers/helpful, but not related to the internals of how MissionLZ works
  • When I clone the repo, the internals of MissionLZ that I don't need to touch are obviously separate
  • The purpose-built scripts for end users have clear names like deploy.sh, clean.sh, deploy_ui.sh
@brooke-hamilton brooke-hamilton changed the title end-user facing scripts should be easily identifiable End-user facing scripts should be easily identifiable Apr 26, 2021
@brooke-hamilton brooke-hamilton added the core New feature or request label Apr 26, 2021
@glennmusa glennmusa self-assigned this May 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants