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

Update README #78

Closed
arthurbdiniz opened this issue Oct 10, 2018 · 8 comments
Closed

Update README #78

arthurbdiniz opened this issue Oct 10, 2018 · 8 comments
Labels
documentation Something related to the documentation of the project enhancement New feature or request good first issue Good for newcomers Hacktoberfest help wanted Extra attention is needed

Comments

@arthurbdiniz
Copy link

Problem description

There is a lot of things on README that its necessary to change

Expected Behavior

Clean README

Current Behavior

This that its necessary to remove:

  • Remove Heroku Deploy (its not been used)
  • Re-link License
  • Update Docker commands with dev and prod environments
  • Remove Vagrant Tutorial (its not been used)
@arthurbdiniz arthurbdiniz added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers documentation Something related to the documentation of the project Hacktoberfest labels Oct 10, 2018
@arthurbdiniz arthurbdiniz added this to the Ponto de Controle 2 milestone Oct 10, 2018
@trevlewis
Copy link

@arthurbdiniz I can take this. Are all the environment details in the YAML files?

@arthurbdiniz
Copy link
Author

arthurbdiniz commented Oct 10, 2018

Hi @trevlewis , thank you for your interest in our project! 😄

All the config file for docker its in docker-compose-dev.yml and docker-compose-prod.yml.

But all you need to update on README from docker its create two topics, one with dev environment and another with production.

The outdated part is that now its necessary to pass the path of the .yml file:

Ex

$ docker-compose -f docker-compose-dev.yml build
$ docker-compose -f docker-compose-dev.yml up -d

@trevlewis
Copy link

@arthurbdiniz Awesome. I will get that done here in a little bit! Thank you for the information!

@arthurbdiniz
Copy link
Author

@arthurbdiniz Awesome. I will get that done here in a little bit! Thank you for the information!

You are welcome. Any doubt will be available right here!

@trevlewis
Copy link

Hey @arthurbdiniz would you look at this version and see if it is what you want? The indent with 4 spaces wasn't working for me for some reason so I had to use the back ticks.
https://github.com/trevlewis/SIGS-GCES/blob/develop/README.md

@arthurbdiniz
Copy link
Author

@trevlewis could you please send the PR? Its easier to review.

@trevlewis
Copy link

@arthurbdiniz here is the PR #80

@arthurbdiniz
Copy link
Author

arthurbdiniz commented Oct 10, 2018

@trevlewis your base fork its pointing to the wrong repository

It should be selected GCES-2018-2/SIGS-GCES
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something related to the documentation of the project enhancement New feature or request good first issue Good for newcomers Hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants