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

📝 (scripts) Add documentation for sugar scripts #4

Open
jmaupetit opened this issue Mar 9, 2018 · 1 comment
Open

📝 (scripts) Add documentation for sugar scripts #4

jmaupetit opened this issue Mar 9, 2018 · 1 comment
Assignees
Milestone

Comments

@jmaupetit
Copy link
Contributor

Purpose

Our development environment relies on Docker and docker-compose, leading to permission issues on HOST while working on the project. To solve these kind of issues and ease developer on-boarding on the project, we wrote a bunch of shell scripts (bash) to build, run and test Fonzie.

Even if those scripts are relevant to improve the developer experience, they raise two kind of problems we need to address:

  1. wrapping docker(-compose) commands can appear unnecessary for advanced users that prefer using docker raw commands,
  2. hiding the underlying docker complexity will not incentive new users to learn it from the basis.

Proposal

We need to exhaustively document those scripts to explain what they are doing (by comparing them with docker(-compose) raw commands) and how they can ease the developer life.

@jmaupetit jmaupetit self-assigned this Mar 9, 2018
@jmaupetit jmaupetit added this to the 0.1.0 milestone Mar 9, 2018
@jmaupetit jmaupetit changed the title docs(scripts) Add documentation for sugar scripts 📝 (scripts) Add documentation for sugar scripts Mar 23, 2018
@jmaupetit
Copy link
Contributor Author

jmaupetit commented Mar 23, 2018

I think, this issue needs an update since many things will change after #11 will have been implemented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants