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

Updating instructions #6035

Merged
merged 13 commits into from
Oct 25, 2019
Merged

Updating instructions #6035

merged 13 commits into from
Oct 25, 2019

Conversation

SCdF
Copy link
Contributor

@SCdF SCdF commented Oct 18, 2019

Reworking our easy deployment section to make it even easier
(hopefully), by adding GUI instructions (kitematic) and a
docker-compose file for CLI, for folks who don't want to do core
development and instead are just checking out the reference app or are
developing configurations of their own.

Moved the Supported Browsers section up as it's not realy anything to do
with development setup, and should really be known by everyone.

Reworking our easy deployment section to make it even easier
(hopefully), by adding GUI instructions (kitematic) and a
docker-compose file for CLI, for folks who don't want to do core
development and instead are just checking out the reference app or are
developing configurations of their own.

Moved the Supported Browsers section up as it's not realy anything to do
with development setup, and should really be known by everyone.
@SCdF SCdF requested a review from abbyad October 18, 2019 13:49
@SCdF
Copy link
Contributor Author

SCdF commented Oct 18, 2019

@abbyad let me know if this is what you were thinking

@Hareet
Copy link
Member

Hareet commented Oct 18, 2019

@SCdF
Kitematic has a few constraints that are making our setup more complicated than simply clicking on our image.

Kitematic issues:

  • In order to create a custom docker network, which our setup requires to run, you have to open up a CLI terminal inside Kitematic and paste docker commands.
  • Same as above to create docker volumes and connect them to our two containers
  • Run haproxy container after medic-os

Kitematic process would be:

  • Launch Kitematic
  • Search "Medic Mobile" or "Medic OS"
  • Download image
  • Open terminal, run:
  • docker create network medic-net
  • docker create volume medic-data
  • Launch Medic-OS
  • configure it to use network and volume
  • configure environment variables
  • Launch HAproxy
  • configure it use network and volume
  • configure environment variables

In my opinion, I feel it's easier to ask the user to copy/paste the compose file, open a terminal once and run:

  • export variables
  • docker-compose up

Basically, all of the definitions found in our docker-compose yaml have to be manually recreated in terminal or configured after the user launches the image from Kitematic.

Previously, I was attempting to make the image have entrypoint scripts that could bootstrap around the kitematic constraints. I can revisit that idea if you think its best, but that won't be ready for CHT release.

Can we only highlight the compose method for now/release and hop on a call to discuss if Kitematic should be our future?

Copy link
Contributor

@abbyad abbyad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I think the content is helpful. There are places we may need to change the tone based on the type of guide it is, and update some CHT language for consistency. I think @CescaGarrett can help with that aspect.

Also, I think that the README is getting too large and the Dev Setup Tests and Automated Deployment on Travis should be moved to a separate file focused on setup for those contributing to the Core Framework itself.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
config/default/GUIDE.md Outdated Show resolved Hide resolved
config/default/GUIDE.md Outdated Show resolved Hide resolved
@SCdF SCdF requested a review from abbyad October 24, 2019 07:49
README.md Outdated Show resolved Hide resolved
@SCdF SCdF requested a review from abbyad October 24, 2019 14:19
Copy link
Contributor

@abbyad abbyad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, overall I think this structure is much clearer!

The INSTALL file could use some sub headers, and other than that it's mostly minor changes or areas that could be made more concise.

INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
config/default/GUIDE.md Outdated Show resolved Hide resolved
config/default/GUIDE.md Outdated Show resolved Hide resolved
config/default/GUIDE.md Outdated Show resolved Hide resolved
config/default/GUIDE.md Outdated Show resolved Hide resolved
config/default/GUIDE.md Outdated Show resolved Hide resolved
abbyad and others added 2 commits October 24, 2019 12:00
@SCdF SCdF requested a review from abbyad October 24, 2019 18:27
config/default/GUIDE.md Outdated Show resolved Hide resolved
config/default/GUIDE.md Outdated Show resolved Hide resolved
Copy link
Contributor

@abbyad abbyad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, nice work @SCdF!

No need to hold this back any longer. It reads cleanly now and we can continue to improve over time as needed.

@SCdF SCdF merged commit 502d343 into master Oct 25, 2019
@SCdF SCdF deleted the update_cht_instructions branch October 25, 2019 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants