-
-
Notifications
You must be signed in to change notification settings - Fork 209
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
Updating instructions #6035
Conversation
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.
@abbyad let me know if this is what you were thinking |
@SCdF Kitematic issues:
Kitematic process would be:
In my opinion, I feel it's easier to ask the user to copy/paste the compose file, open a terminal once and run:
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? |
There was a problem hiding this 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.
c5aed17
to
70ebd49
Compare
There was a problem hiding this 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.
Co-Authored-By: Marc Abbyad <marc@medicmobile.org>
Trying to be a little more concise for clarity.
There was a problem hiding this 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.
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.