Reference normal requirements / Readme enhancements #155
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ote about branch specification
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR helps increase likelihood of getting to stated 5 minutes to joy:
readme.mdSpecific variable and file name changes needed to more quickly get to joy from the default settings
A note on where to specify repo branch setting
These changes are useful for someone kicking the tires on this stack. For example, you have an existing django project and need to make minor tweaks for to use this playbook. You push a branch i.e.
ads-testand want to use this instead of master. Also, captures missing note about need to rename the nginx template file.env_vars/vagrant.ymlChanged
requirements_fileto match the name given in the readme's project organization. This still works with youtube-audio-dl as it relies onrequirements.txt.I think someone who has more experience using playbooks might realize these changes are necessary. However, if you're dabbling in this advanced devops setup, these extra bumpers might make it easier for someone to try out.