Skip to content

Commit

Permalink
docs: use double quotes instead of open/close
Browse files Browse the repository at this point in the history
Signed-off-by: Reuben Miller <[email protected]>
  • Loading branch information
reubenmiller committed Apr 4, 2023
1 parent 340e0e6 commit 21a7af3
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTOR-LICENSE-AGREEMENT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
THIS CONTRIBUTOR LICENSE AGREEMENT (this Agreement), is effective for each Contribution by signing-off the Submission by using the option "-s" in "git commit", which will generate a sign-off statement with your user name and email address as described in [**CONTRIBUTING.md**](https://github.com/thin-edge/thin-edge.io/blob/main/CONTRIBUTING.md).
THIS CONTRIBUTOR LICENSE AGREEMENT (this "Agreement"), is effective for each Contribution by signing-off the Submission by using the option "-s" in "git commit", which will generate a sign-off statement with your user name and email address as described in [**CONTRIBUTING.md**](https://github.com/thin-edge/thin-edge.io/blob/main/CONTRIBUTING.md).

This Agreement is for Your protection as a Contributor as well as the protection of **Software AG**.

Expand All @@ -8,13 +8,13 @@ You accept and agree to the following terms and conditions for Your Contribution

You read, understand and follow the guidelines for the various roles You represent in **Software AG**’s opensource communities, starting with the contributor guidelines [**CONTRIBUTING.md**](https://github.com/thin-edge/thin-edge.io/blob/main/CONTRIBUTING.md).

**Contribution** means any original work of authorship, including any modification of or addition to an existing work including any associated comments and documentation, that you submit to **Software AG** in any manner for inclusion in any Work.
**"Contribution"** means any original work of authorship, including any modification of or addition to an existing work including any associated comments and documentation, that you submit to **Software AG** in any manner for inclusion in any Work.

**Submission** means the act of submitting Your Contributions by You to the projects managed by **Software AG** in any form of electronic, verbal, or written communication, especially using the features of the respective source code versioning platforms.
**"Submission"** means the act of submitting Your Contributions by You to the projects managed by **Software AG** in any form of electronic, verbal, or written communication, especially using the features of the respective source code versioning platforms.

**Work** means any project, work or materials owned or managed by **Software AG**.
**"Work"** means any project, work or materials owned or managed by **Software AG**.

**You** and **Your** means you and any organization on whose behalf you are entering this agreement.
**"You"** and **"Your"** means you and any organization on whose behalf you are entering this agreement.

You represent that:

Expand Down
2 changes: 1 addition & 1 deletion GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The project has a hierarchy to solve these two problems:
* This makes it easier to decide on technical questions
* Everyone has to agree on the core project as it is the foundations to all others.
* At the periphery, sub-projects might be related to specific eco-systems (e.g. Cumulocity or Moneo) and therefore have independent decision processes.
* At an intermediate level, one might have sub-projects related to specific use-cases like JSON over MQTT.
* At an intermediate level, one might have sub-projects related to specific use-cases like "JSON over MQTT".
* All the sub-projects share a common repository - to ease consistency across projects and over time.
* Labels are used to organize issues/PRs/discussions along sub-projects.
* Code ownership is used to enforce cooperation around key components, but the default is to let things open and to trust each other, using version control as a safety net.
Expand Down
10 changes: 5 additions & 5 deletions docs/src/howto-guides/child_device_config_management_agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,17 +76,17 @@ Once the upload is complete, the agent should notify thin-edge about the upload
**Payload**:

```json
{ "type": "c8y-configuration-plugin, "path": /child/local/fs/path }
{ "type": "c8y-configuration-plugin", "path": "/child/local/fs/path" }
```

# Handle config snapshot requests from thin-edge

Handling config snapshot requests from thin-edge is a 4-step process:

1. Subscribe to, and receive config snapshot requests via MQTT
1. Send an executing operation status update to acknowledge the receipt of the request via MQTT
1. Send an "executing" operation status update to acknowledge the receipt of the request via MQTT
1. Upload the requested config file to the URL received in the request via HTTP
1. Send a successful operation status update via MQTT
1. Send a "successful" operation status update via MQTT

These steps are explained in detail below:

Expand Down Expand Up @@ -156,10 +156,10 @@ a "failed" status update must be sent instead, to the same topic as follows:
Handling config update requests from thin-edge is a 5-step process:

1. Subscribe to, and receive config update requests via MQTT
1. Send an executing operation status update to acknowledge the receipt of the request via MQTT
1. Send an "executing" operation status update to acknowledge the receipt of the request via MQTT
1. Download the config file update from the URL received in the request via HTTP
1. Apply the config file update on the child device
1. Send a successful operation status update via MQTT
1. Send a "successful" operation status update via MQTT

The child device agent must subscribe to the `tedge/{child-d}/commands/req/config_update` MQTT topic
to receive the config update requests from thin-edge.
Expand Down
6 changes: 3 additions & 3 deletions docs/src/tutorials/child-device-config-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Follow these steps to bootstrap the child device:
**Payload:**

```json
{ "type": "c8y-configuration-plugin, "path": /child/local/fs/path }
{ "type": "c8y-configuration-plugin", "path": "/child/local/fs/path" }
```

**Example:**
Expand Down Expand Up @@ -311,7 +311,7 @@ Performing config update is an 8-step process:
else the operation will fail with a timeout.
```

5. Optionally send an executing operation status update to acknowledge the receipt of the request via MQTT as follows:
5. Optionally send an "executing" operation status update to acknowledge the receipt of the request via MQTT as follows:

**Topic:**

Expand Down Expand Up @@ -352,7 +352,7 @@ Performing config update is an 8-step process:

The connector can then apply the downloaded configuration file update on the device.

8. Send a successful operation status update via MQTT
8. Send a "successful" operation status update via MQTT

Once the update is applied, send a "successful" MQTT status message as follows:

Expand Down

0 comments on commit 21a7af3

Please sign in to comment.