Skip to content

Commit 5b5328e

Browse files
authored
Merge pull request #134023 from dominicbetts/pnp-model-repo-feedback
Address feedback
2 parents aa5cc9b + 041f821 commit 5b5328e

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

articles/iot-pnp/concepts-model-repository.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Understand concepts of the Device Model Repository | Microsoft Docs
3-
description: As a solution developer or an IT professional, learn about the basic concepts of the Device Model Repository.
2+
title: Understand concepts of the device model repository | Microsoft Docs
3+
description: As a solution developer or an IT professional, learn about the basic concepts of the device model repository.
44
author: rido-min
55
ms.author: rmpablos
66
ms.date: 09/30/2020
@@ -19,20 +19,20 @@ The DMR defines a pattern to store DTDL interfaces in a folder structure based o
1919

2020
Microsoft hosts a public DMR with these characteristics:
2121

22-
- Curated models. Microsoft reviews and approves all available interfaces using an open GitHub PR validation workflow.
22+
- Curated models. Microsoft reviews and approves all available interfaces using a GitHub pull request (PR) validation workflow.
2323
- Immutability. After it's published, an interface can't be updated.
24-
- Hyper-scale. Microsoft provides all the required infrastructure to create a secure and highly scalable endpoint.
24+
- Hyper-scale. Microsoft provides the required infrastructure to create a secure, scalable endpoint where you can publish and consume device models.
2525

2626
## Custom device model repository
2727

28-
You can use the same DMR pattern in any storage medium, such as local file system or custom HTTP web servers, to create a custom DMR. You can retrieve models from the custom DMR in the same way as from the public DMR simply by changing the base URL used to access the DMR.
28+
You can use the same DMR pattern in any storage medium, such as local file system or custom HTTP web servers, to create a custom DMR. You can retrieve device models from the custom DMR in the same way as from the public DMR simply by changing the base URL used to access the DMR.
2929

3030
> [!NOTE]
31-
> The tools used to validate the models in the public DMR can be reused in custom repositories.
31+
> Microsoft provides tools to validate device models in the public DMR. You can reuse these tools in custom repositories.
3232
3333
## Public models
3434

35-
The public digital twin models stored in the model repository are available to everyone to consume and integrate in their applications. Public models enable an open eco-system for device builders and solution developers to share and reuse their IoT Plug and Play device models.
35+
The public device models stored in the model repository are available for everyone to consume and integrate in their applications. Public device models enable an open eco-system for device builders and solution developers to share and reuse their IoT Plug and Play device models.
3636

3737
Refer to the [Publish a model](#publish-a-model) section for instructions on how to publish a model in the model repository to make it public.
3838

@@ -42,7 +42,7 @@ All interfaces in the `dtmi` folders are also available from the public endpoint
4242

4343
### Resolve models
4444

45-
To programmatically access these interfaces, you need to convert a dtmi to a relative path that you can use to query the public endpoint. The following code sample shows you how to do this:
45+
To programmatically access these interfaces, you need to convert a DTMI to a relative path that you can use to query the public endpoint. The following code sample shows you how to do this:
4646

4747
To convert a DTMI to an absolute path we use the `DtmiToPath` function, with `IsValidDtmi`:
4848

@@ -83,14 +83,14 @@ string modelContent = await _httpClient.GetStringAsync(fullyQualifiedPath);
8383
1. Fork the public GitHub repo: [https://github.com/Azure/iot-plugandplay-models](https://github.com/Azure/iot-plugandplay-models).
8484
1. Clone the forked repo. Optionally create a new branch to keep your changes isolated from the `main` branch.
8585
1. Add the new interfaces to the `dtmi` folder using the folder/filename convention. See the [add-model](#add-model) tool.
86-
1. Validate the models locally using the [scripts to validate changes](#validate-files) section.
86+
1. Validate the device models locally using the [scripts to validate changes](#validate-files) section.
8787
1. Commit the changes locally and push to your fork.
88-
1. From your fork, create a PR that targets the `main` branch. See [Creating an issue or pull request](https://docs.github.com/free-pro-team@latest/desktop/contributing-and-collaborating-using-github-desktop/creating-an-issue-or-pull-request) docs.
89-
1. Review the [PR requirements](https://github.com/Azure/iot-plugandplay-models/blob/main/pr-reqs.md).
88+
1. From your fork, create a pull request that targets the `main` branch. See [Creating an issue or pull request](https://docs.github.com/free-pro-team@latest/desktop/contributing-and-collaborating-using-github-desktop/creating-an-issue-or-pull-request) docs.
89+
1. Review the [pull request requirements](https://github.com/Azure/iot-plugandplay-models/blob/main/pr-reqs.md).
9090

91-
The PR triggers a series of GitHub actions that will validate the new submitted interfaces, and make sure your PR satisfies all the checks.
91+
The pull request triggers a series of GitHub actions that will validate the new submitted interfaces, and make sure your pull request satisfies all the checks.
9292

93-
Microsoft will respond to a PR with all checks in three business days.
93+
Microsoft will respond to a pull request with all checks in three business days.
9494

9595
### add-model
9696

@@ -104,7 +104,7 @@ Watch the console output for any error messages.
104104

105105
### Local validation
106106

107-
You can run the same validation checks locally before submitting the PR to help diagnosing issues in advance.
107+
You can run the same validation checks locally before submitting the pull request to help diagnose issues in advance.
108108

109109
#### validate-files
110110

@@ -120,7 +120,7 @@ You can run the same validation checks locally before submitting the PR to help
120120

121121
#### validate-models
122122

123-
You can run the [DTDL Validation Sample](https://github.com/Azure-Samples/DTDL-Validator) to validate your models locally.
123+
You can run the [DTDL Validation Sample](https://github.com/Azure-Samples/DTDL-Validator) to validate your device models locally.
124124

125125
## Next steps
126126

0 commit comments

Comments
 (0)