Skip to content

Commit

Permalink
Add deploy docs with stable version on release and update broken urls…
Browse files Browse the repository at this point in the history
… in README (#1074)

* Add deploy docs with stable version

* Update documentations urls in README
  • Loading branch information
hocinehacherouf authored Aug 11, 2022
1 parent bb7ecb9 commit b2c8410
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/publish-documentation-new-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,7 @@ jobs:
run: |
git config user.name github-actions
git config user.email [email protected]
- name: Deploy docs
- name: Deploy docs with stable version
run: mike deploy --push stable
- name: Deploy docs with latest version
run: mike deploy --push --update-aliases ${GITHUB_REF_NAME} latest
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
This project aims to provide a solution for handling IoT Devices easyly.
It leverages on Azure IoT Hub for connectivity and device management.

![https://cgi-fr.github.io/IoT-Hub-Portal/images/architecture.png](https://cgi-fr.github.io/IoT-Hub-Portal/images/architecture.png)
![IoT Hub Portal Architecture](https://cgi-fr.github.io/IoT-Hub-Portal/stable/images/architecture.png)

## Features

Expand All @@ -25,7 +25,7 @@ It leverages on Azure IoT Hub for connectivity and device management.
The following should be completed before proceeding with the IoT Hub Portal development or deployment in your environment.

* You must have an Azure subscription. Get an [Azure Free account](https://azure.microsoft.com/en-us/offers/ms-azr-0044p/) to get started.
* You must have configured an Azure AD B2C Tenant with applications. See [Portal AD applications configuration](https://cgi-fr.github.io/IoT-Hub-Portal/docs/b2c-applications.html) page.
* You must have configured an Azure AD B2C Tenant with applications. See [Portal AD applications configuration](https://cgi-fr.github.io/IoT-Hub-Portal/stable/b2c-applications) page.
* Understandr how IoTEdge LoraWAN StarterKit work. Have a look at [https://azure.github.io/iotedge-lorawan-starterkit](https://azure.github.io/iotedge-lorawan-starterkit) to get started.

## Quick Start
Expand All @@ -44,7 +44,7 @@ The template will deploy in your Azure subscription the Following resources:
### Instructions

1. Choose a solution prefix for your deployment.
1. Use [Portal AD applications configuration](https://cgi-fr.github.io/IoT-Hub-Portal/docs/b2c-applications.html) page to configure your AD B2C Tenant.
1. Use [Portal AD applications configuration](https://cgi-fr.github.io/IoT-Hub-Portal/stable/b2c-applications) page to configure your AD B2C Tenant.
> You should have recorded the following information:
> * OpenID authority: `<your-openid-authority>`
> * OpenID metadata URL: `<your-openid-provider-metadata-url>`
Expand Down

0 comments on commit b2c8410

Please sign in to comment.