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
Aws docs n8 #167
Aws docs n8 #167
Conversation
@nmerket This should make things a little easier for AWS users. Did I update the changelog file the way you want? :) |
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.
Thanks for doing this!
.. change:: | ||
:tags: documentation | ||
:pullreq: 167 | ||
:tickets: 168 | ||
|
||
Minor updates to documentation. |
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.
I'm on the fence about whether we need to document in the changelog minor things like this. What do you think, @rHorsey?
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.
Seems like this is not worthy of changelog, as nothing in the code is actually changing.
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.
@vtnate @nmerket As written def not impactful, but I actually think tracking docs changes is critical, not least of all because we seriously need to start 'ataboy-ing' every docs improvement. Also if I go read something and I'm like - since when has this been the recommended way of doing whatever - I can still go find the change to the docs and then hopefully reverse-engineer what's up. I'd just slightly change this to read Made minor clarity updates in configuring local docker and aws setups.
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.
Also I really like the idea of every PR that get's merged having an entry - it's something that I see in projects like dask and sqlalchemy and I really like what it does to the culture of development and use of the projects.
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.
Dunno if it's appropriate here, but in urbanopt we're following the openstudio-extension changelog pattern, and using that script to access the github issues for direct copy/paste into the changelog. It's pretty slick, in my experience, at letting you run the script just before a release and updating the changelog easily. Here is an example changelog built using that script.
Co-authored-by: Noel Merket <noel.merket@nrel.gov>
Addresses #167
Pull Request Description
Checklist
Not all may apply