Skip to content
This repository has been archived by the owner on Aug 30, 2021. It is now read-only.

Update README about grunt environment modes #643

Merged

Conversation

lirantal
Copy link
Member

updating README file with more elaborate instructions on running grunt in different environment modes (dev/prod/secure ssl)

@rhutchison
Copy link
Contributor

LGTM


That's it! Your application should be running. To proceed with your development, check the other sections in this documentation.
If you encounter any problems, try the Troubleshooting section.

* explore ```config/env/development.js``` for development environment configuration options
Copy link
Member

Choose a reason for hiding this comment

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

This could just be single backtick

Copy link
Member Author

Choose a reason for hiding this comment

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

since we are using 3 ticks anyway in the rest of the README I'll leave it at that so that we are consistent.

Copy link
Member

Choose a reason for hiding this comment

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

We have to use 3 ticks for code blocks, but for inline strings 1 tick can be used.

Copy link
Member

Choose a reason for hiding this comment

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

@lirantal, it might look okay at GitHub, but nothing guarantees fenced code block at inline text looks good elsewhere — e.g. editor markdown previews etc.

Copy link
Member Author

Choose a reason for hiding this comment

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

got it, I thought you were referring to the actual code blocks and not just the inline.
I'll get it fixed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Cleaning up the code blocks here: #647

```
* explore ```config/env/production.js``` for production environment configuration options

## Running in a Secure environment
Copy link
Contributor

Choose a reason for hiding this comment

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

this should be a sub-section within _Running in Production mode_ section because it depends on the secure config variable in config/env/production.js

change to #### Running in Secure environment

Also, consider changing the section title to _Running with TLS (SSL)_

Copy link
Member Author

Choose a reason for hiding this comment

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

Indeed I'lll change the 2 "#" to 3 so that it is after the 'running in production mode' and not within it (I think it's much clearer that way instead of nesting it too much levels).

Will also update the title.

…t in different environment modes (dev/prod/secure ssl)

updating title for the SSL section and added information about the port number in secure environment mode
@lirantal lirantal force-pushed the enhancement/README-update-grunt-startup branch from ccbd394 to 39e4282 Compare July 12, 2015 16:17
@lirantal
Copy link
Member Author

@jloveland @ilanbiala thanks for the code review.
squashed commits and ready for merge.

lirantal added a commit that referenced this pull request Jul 12, 2015
…-startup

Update README about grunt environment modes
@lirantal lirantal merged commit ab68fd2 into meanjs:0.4.0 Jul 12, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants