Skip to content
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.

Sign up for GitHub

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

Jump to bottom

add contributing.md and modify readme to point to wiki #181

Merged
merged 4 commits into from
Jun 7, 2018
Merged

add contributing.md and modify readme to point to wiki #181

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
67ff934
add contributing.md and modify readme to point to wiki
kln4dt Jun 6, 2018
a1ddb71
update readme.md
kln4dt Jun 6, 2018
5bd58f9
remove overview section and move resources to bottom
kln4dt Jun 6, 2018
300b40a
add overview section with link to wiki at top
kln4dt Jun 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 3 additions & 58 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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._
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add another at top...just not under resources header...probably in overview section would be best.


## Resources
Please refer to the [Wiki](https://github.com/Azure/iotedgedev/wiki) for details on setup, usage, and troubleshooting.

Please refer to the [Contributing file](CONTRIBUTING.MD) for details on contributing changes.

## Quickstart
Here is the absolute fastest way to get started with IoT Edge Dev. This quickstart will run a container, create a solution, setup Azure resources, build and deploy modules to your device, setup and start the Edge Runtime and then monitor messages flowing into IoT Hub.
Expand Down Expand Up @@ -63,57 +58,7 @@ The only thing you need to install is Docker. All of the other dev dependencies

`iotedgedev monitor`

## Overview
The **Azure IoT Edge Dev Tool** enables you to do all of the following with simple one-line CLI commands.

1. **Start Container**:

`docker run -it -v /var/run/docker.sock:/var/run/docker.sock -v c:/temp/iotedge:/home/iotedge microsoft/iotedgedev`

This container includes all of the dependencies you need for IoT Edge development, including:

- Docker
- .NET Core SDK
- Python
- Pip
- Azure CLI

You can also directly install with: `pip install iotedgedev`

1. **Create Solution**: Create a new IoT Edge Solution that includes a sample module and all the the required configuration files.

`iotedgedev solution edgesolution1`

`cd edgesolution1`

1. **Setup Azure**: Creates or selects your Azure IoT Hub and Edge Device and updates your Environment Variables.

`iotedgedev azure`

> This must be run from the root of your solution, so make sure you cd into the `edgesolution1` folder before you run this command.

1. **Build, Push & Deploy**: Build, Push and Deploy modules:

`iotedgedev push --deploy`

> This will `dotnet build`, `publish`, `docker build, tag and push` and `deploy modules` to your IoT Edge device.

If your module is not dotnet, then the dotnet build/publish steps will be skipped.

1. **Setup & Start**: Setup and Start the IoT Edge Runtime:

`iotedgedev start`

1. **View Messages**: View Messages Sent from IoT Edge to IoT Hub:

`iotedgedev monitor`

1. **View Logs**: View and Save Docker log files:

`iotedgedev docker --logs`

1. **Setup Custom Registry**: Use a Custom Container Registry:

`iotedgedev docker --setup-registry`
## Resources
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you feel about leaving as-is for now and revisit it later?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, will be good to re-read it with some fresher eyes

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, let's still do the link at the top, comment below and call it good.

Please refer to the [Wiki](https://github.com/Azure/iotedgedev/wiki) for details on setup, usage, and troubleshooting.

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.
Please refer to the [Contributing file](CONTRIBUTING.MD) for details on contributing changes.