Corrections to instructions, terminology, and docs link - #94
Merged
Conversation
Thank you for the write-up! Following are my suggestions for corrections. - Pin version of Pyramid to 1.7, else pip will install the latest release on PyPI. This will future-proof your instructions and make them consistent with your Required Tools. - virtualenv and pip do not need to be installed with Python 3.5 because it now includes venv and pip. You do, however, need to update both. You'll need to update your PNG, though. - Use `python3 -m venv` to create a virtual environment, as this is now the recommended way, although it is not yet documented, per https://bugs.python.org/issue27285 - Use proper term for a Python virtual environment. venv, virtualenv, and pyvenv (which is merely a script that wraps venv) are all implementations of a virtual environment. - Use official, canonical URL for Pyramid docs. Although I did not include it in this PR, I thought I would mention that Pyramid comes with three scaffolds—starter, alchemy, and zodb—the latter two of which have full tutorials at http://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki2/index.html and http://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki/index.html Additionally, we now have four cookiecutters that perform a similar function to the scaffolds, but go further by simplifying the entire installation process. Those are located at https://github.com/Pylons/?utf8=%E2%9C%93&query=cookiecutter
Owner
|
Wow, this is awesome! Thank you so much for taking the time to make these changes @stevepiercy. I'm merging this one and will do some more reading based on your links. It's pretty clear my lack of time with Pyramid created some weaknesses in this post. I really appreciate the helping hand making this post better. |
Contributor
Author
|
You're welcome! I'm glad to help with Pyramid docs. BTW, if you have any public projects that use Pyramid, I recently pushed out this page: |
This file contains hidden or 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
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.
Thank you for the write-up! Following are my suggestions for corrections.
python3 -m venvto create a virtual environment, as this is now the recommended way, although it is not yet documented, per https://bugs.python.org/issue27285Although I did not include it in this PR, I thought I would mention that Pyramid comes with three scaffolds—starter, alchemy, and zodb—the latter two of which have full tutorials at http://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki2/index.html and http://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki/index.html Additionally, we now have four cookiecutters that perform a similar function to the scaffolds, but go further by simplifying the entire installation process. Those are located at https://github.com/Pylons/?utf8=%E2%9C%93&query=cookiecutter