Feature/doc fixes for open source #42
Merged
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
marinatedpork
approved these changes
Dec 3, 2019
eschwartz
reviewed
Dec 3, 2019
| --- | ||
|
|
||
| **Version information** | ||
| - The version of DCE. |
There was a problem hiding this comment.
@joshmarsh should this be:
The version of dce-cli
?
eschwartz
reviewed
Dec 3, 2019
|
|
||
| **To Reproduce** | ||
| Steps to reproduce the behavior: | ||
| 1. Go to '...' |
There was a problem hiding this comment.
I'd scrap these example steps -- kind of confusing for a CLI tool...
eschwartz
reviewed
Dec 3, 2019
| - Terraform version (if using directly) | ||
|
|
||
| **Describe the bug** | ||
| A clear and concise description of what the bug is. |
There was a problem hiding this comment.
Maybe add something like:
Please include the CLI command you ran, and the full output from the command
eschwartz
reviewed
Dec 3, 2019
| --- | ||
|
|
||
| **Is your feature request related to a problem? Please describe.** | ||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] |
There was a problem hiding this comment.
You could put some of these instructions in comment tags, so they don't show up in actual issues, eg:
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
eschwartz
reviewed
Dec 3, 2019
| ## Types of changes | ||
|
|
||
| <!-- | ||
| What types of changes does your code introduce to the module? |
eschwartz
reviewed
Dec 3, 2019
| - [ ] I have updated the `CHANGELOG.md` under a `## next` release, with a short summary of my changes | ||
|
|
||
|
|
||
| ## Dependencies and Blockers |
There was a problem hiding this comment.
I might cut this whole section. This was original intended more for at Optum, where we might be blocked/blocking something happening on another dev team
eschwartz
reviewed
Dec 3, 2019
|
|
||
| The Lambda and CodeBuild function code is written in Golang. We prefer that similar contributed code also be written in Golang. Please ensure your Golang code is formatted by [gofmt](https://golang.org/cmd/gofmt/) and linted by [golint](https://godoc.org/golang.org/x/lint). | ||
| The source code for this project is written in Go. You are welcome to add versions of files for other languages, however the core code will remain in Go. |
There was a problem hiding this comment.
You are welcome to add versions of files for other languages
🤔 not so sure about that...
eschwartz
reviewed
Dec 3, 2019
| 1. Open a pull request and complete the provided PR template. Thank you for your contribution! A dialog will ensue. | ||
| * Try to make the name concise and descriptive. | ||
| * Give a good description of the change being made. Since this is very subjective, see the [Updating Your Pull Request (PR)](#updating-your-pull-request-pr) section below for further details. | ||
| * Every pull request should be associated with one or more issues. If no issue exists yet, please create your own. |
eschwartz
reviewed
Dec 3, 2019
|
|
||
| DCE users can "lease" an AWS account for a defined period of time and with a limited budget. | ||
|
|
||
| At the end of the lease, or if the lease's budget is reached, the account is wiped clean and returned to the account pool so it may be leased again. |
There was a problem hiding this comment.
👍 for context
Should maybe link to our readthedocs page for DCE (will be up tomorrow morning...)
eschwartz
reviewed
Dec 3, 2019
| @@ -129,3 +138,8 @@ Opening AWS Console in Web Browser | |||
|
|
|||
| To change the logging level of the DCE CLI, set the DCE_LOG_LEVEL environment variable to `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, or `PANIC`. When the log level is `INFO`, only un-prefixed log message will be output. This is the default behavior. | |||
|
|
|||
| ## Contributing to DCE | |||
|
|
|||
| DCE was born at Optum, but belongs to the community. Improve your cloud experience and [open a PR](https://github.com/Optum/dce/pulls). | |||
There was a problem hiding this comment.
|
@eschwartz New PRs: |
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.
Related: https://github.optum.com/OPTUMSource/OSS-Community-Contribution/pull/23