add contributing.md and modify readme to point to wiki #181
Conversation
README.md
Outdated
|
|
||
| Please refer to the [Wiki](https://github.com/Azure/iotedgedev/wiki) for details on setup, usage, and troubleshooting. |
There was a problem hiding this comment.
Let's have the quickstart duplicated here, so it's not just a blank page.
Also include a link to the contributing page.
Also, from the wiki, have a contributing node in the TOC, but point it to the contributing.md doc.
You get some nice stuff on github if you have the contributing.md file https://blog.github.com/2012-09-17-contributing-guidelines/
|
Will update the TOC once this is merged to avoid pointing to a nonexistent file |
README.md
Outdated
| - It speeds up your inner-loop dev (dev, debug, test) by reducing multi-step build & deploy processes into one-line CLI commands and well as drive your outer-loop CI/CD pipeline. _You can use all the same commands in both stages of your development life-cycle._ | ||
|
|
||
| ## Resources |
There was a problem hiding this comment.
Please put this on bottom of page
README.md
Outdated
| `iotedgedev docker --setup-registry` | ||
|
|
||
| Please see [Azure IoT Edge Dev Resources](https://github.com/jonbgallant/azure-iot-edge-dev) for links to official docs and other IoT Edge dev information. |
There was a problem hiding this comment.
I think this line can be removed.
README.md
Outdated
| `iotedgedev monitor` | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
Let's only do the quickstart, not the overview.
README.md
Outdated
| 1. **Setup Custom Registry**: Use a Custom Container Registry: | ||
|
|
||
| `iotedgedev docker --setup-registry` | ||
| ## Resources |
There was a problem hiding this comment.
When looking at the output html file, I feel like we are using the reader hanging at the end of the Quickstart.
Can you come up with a good way to say something like CLICK HERE TO VIEW ALL DOCS, not that exactly, but something like that.
There was a problem hiding this comment.
which links to the wiki? in that case, think it would make sense to pull out the reference to the wiki at the beginning of the resources section and have it here
There was a problem hiding this comment.
How do you feel about leaving as-is for now and revisit it later?
There was a problem hiding this comment.
yeah, will be good to re-read it with some fresher eyes
There was a problem hiding this comment.
Okay, let's still do the link at the top, comment below and call it good.
| @@ -4,11 +4,6 @@ The **Azure IoT Edge Dev Tool** greatly simplifies [Azure IoT Edge](https:/azure | |||
|
|
|||
| - It gets you started with IoT Edge development with the [IoT Edge Dev Container](#iot-edge-dev-container) and IoT Edge Solution Scaffolding that contains a sample module and all the required configuration files. | |||
| - It speeds up your inner-loop dev (dev, debug, test) by reducing multi-step build & deploy processes into one-line CLI commands and well as drive your outer-loop CI/CD pipeline. _You can use all the same commands in both stages of your development life-cycle._ | |||
There was a problem hiding this comment.
I feel like we need a link to the wiki at the top, maybe after the intro. Something like....for full docs see the wiki, link.
There was a problem hiding this comment.
Agreed, that's what I initially had but then coupled it with contributing.md in resources. Want to split that back out or leave the link there and add another reference at the top?
There was a problem hiding this comment.
Let's add another at top...just not under resources header...probably in overview section would be best.
* add contributing.md and modify readme to point to wiki * update readme.md * remove overview section and move resources to bottom * add overview section with link to wiki at top
* Add quickstart video Add quickstart video * Search for subscriptions with a lowercased token; fixes #154 * Handle ambiguous or empty subscription results; related #154 * Add prompt to supply more characters when multiple subs are found * add log level as envvar and testing (#178) * add contributing.md and modify readme to point to wiki (#181) * add contributing.md and modify readme to point to wiki * update readme.md * remove overview section and move resources to bottom * add overview section with link to wiki at top * add Contributing.md content and fix link (#182) * Add test_azurecli and initial token casing tests * Fix IoT Hub SKU prompt, changing duplicate S3 to S2 * Update subscription search to support contains for name matches * Add RUNTIME_LOG_LEVEL to .env.tmp (#186) * Fix Tests
) * Add quickstart video Add quickstart video * Search for subscriptions with a lowercased token; fixes #154 * Handle ambiguous or empty subscription results; related #154 * Add prompt to supply more characters when multiple subs are found * add log level as envvar and testing (#178) * add contributing.md and modify readme to point to wiki (#181) * add contributing.md and modify readme to point to wiki * update readme.md * remove overview section and move resources to bottom * add overview section with link to wiki at top * add Contributing.md content and fix link (#182) * Add test_azurecli and initial token casing tests * Fix IoT Hub SKU prompt, changing duplicate S3 to S2 * Update subscription search to support contains for name matches * Add RUNTIME_LOG_LEVEL to .env.tmp (#186) * Add envvars clean to work around the py2 unicode in envvar issue
No description provided.