Skip to content

Commit

Permalink
Merge pull request #742 from WildernessLabs/jorge-docs
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
jorgedevs authored May 29, 2024
2 parents 99f4ae0 + 1dff5b2 commit ad1374b
Show file tree
Hide file tree
Showing 11 changed files with 28 additions and 50 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode in a new Terminal within enter the following command to create a new Meadow.Desktop project:

```console
dotnet new MeadowDesktop --name LinuxDemo
dotnet new meadow-desktop --name LinuxDemo
```

This Meadow.Desktop application creates a 320x240 pixel window saying `Hello, World` using [MicroLayout](../../../Meadow.Foundation/Libraries_and_Frameworks/MicroLayout/index.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode in a new Terminal within enter the following command to create a new Meadow.Desktop project:

```console
dotnet new MeadowDesktop --name MacDemo
dotnet new meadow-desktop --name MacDemo
```

This Meadow.Desktop application opens a 320x240 pixel window saying `Hello, World` using [MicroLayout](../../../Meadow.Foundation/Libraries_and_Frameworks/MicroLayout/index.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode in a new Terminal within enter the following command to create a new Meadow.Desktop project:

```console
dotnet new Desktop --name WindowsDemo
dotnet new meadow-desktop --name WindowsDemo
```

This Meadow.Desktop application opens a 320x240 pixel window saying `Hello, World` using [MicroLayout](../../../Meadow.Foundation/Libraries_and_Frameworks/MicroLayout/index.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode and in a new Terminal within, enter the following command to create a new Meadow F7 Feather project:

```console
dotnet new CoreComputeModule --name CcmDemo
dotnet new meadow-ccm --name CcmDemo
```

What this Meadow application does is creates an `RgbPwmLed` object on the CCM Dev Kit's onboard RGB LED and cycles through different colors.
Expand Down
2 changes: 1 addition & 1 deletion docs/Meadow/Getting_Started/MCUs/F7_Feather/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode and in a new Terminal within, enter the following command to create a new Meadow F7 Feather project:

```console
dotnet new F7Feather --name F7FeatherDemo
dotnet new meadow-feather --name F7FeatherDemo
```

This Meadow application creates a `RgbPwmLed` object that represents the onboard RGB LED and cycles through different colors.
Expand Down
2 changes: 1 addition & 1 deletion docs/Meadow/Getting_Started/MCUs/Project_Lab/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode and in a new Terminal within, enter the following command to create a new Project Lab project:

```console
dotnet new ProjectLab --name ProjectLabDemo
dotnet new meadow-project-lab --name ProjectLabDemo
```

This project creates a Project Lab demo app that will activate all its onboard sensors (environmental, light and motion sensors, button states) and show its readings periodically on its 320x240 SPI display.
Expand Down
2 changes: 1 addition & 1 deletion docs/Meadow/Getting_Started/SBCs/Jetson_Nano/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode and in a new Terminal within, enter the following command to create a new Meadow.Linux project that will run on your Raspberry Pi:

```console
dotnet new JetsonNano --name JetsonNanoDemo
dotnet new meadow-jetson-nano --name JetsonNanoDemo
```

This Meadow.Linux application shows a basic Meadow app structure with an `Initialize` and `Run` methods with logging strings to confirm in the output the application ran successfully.
Expand Down
2 changes: 1 addition & 1 deletion docs/Meadow/Getting_Started/SBCs/RaspberryPi/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode and in a new Terminal within, enter the following command to create a new Meadow.Linux project that will run on your Raspberry Pi:

```console
dotnet new RaspberryPi --name RaspberryPiDemo
dotnet new meadow-raspberry-pi --name RaspberryPiDemo
```

This Meadow.Linux application shows a basic Meadow app structure with an `Initialize` and `Run` methods with logging strings to confirm in the output the application ran successfully.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode and in a new Terminal within, enter the following command to create a new Meadow.Linux project that will run on your Raspberry Pi:

```console
dotnet new reTerminal --name reTerminalDemo
dotnet new meadow-reterminal --name reTerminalDemo
```

This Meadow.Linux application shows a basic Meadow app structure with an `Initialize` and `Run` methods with logging strings to confirm in the output the application ran successfully.
Expand Down
25 changes: 8 additions & 17 deletions docs/Meadow/Meadow.Cloud/Automatic_Publish/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,20 @@ title: GitHub Action Publish
subtitle: Getting started
---

# Publish Meadow MPAK Action
With GitHub Actions, you can automate the process to publish Meadow MPAKs to a specified collection of devices using [`meadow-cloud-package-publish`](https://github.com/WildernessLabs/meadow-cloud-package-publish) action. It is intended for use within workflows that require deploying updates or new packages to a group of devices managed in Meadow.Cloud.

This GitHub Action is designed to publish Meadow MPAKs to a specified collection of devices. It is intended for use within workflows that require deploying updates or new packages to a group of devices managed in MeadowCloud.

## Description

The "Publish Meadow MPAK" action automates the process of publishing a Meadow MPAK to a collection of devices. This is particularly useful in continuous deployment pipelines, enabling updates to be distributed swiftly and reliably to a designated collection.
The **Publish Meadow MPAK** action automates the process of publishing a Meadow MPAK to a collection of devices. This is particularly useful in continuous deployment pipelines, enabling updates to be distributed swiftly and reliably to a designated collection.

## Inputs

### `api_key`
**Required** The API key for authenticating with Meadow's cloud services. This key should be kept secure.

### `collection_id`
**Required** The ID of the device collection to which the package will be published. This ID specifies the target group of devices.

### `host`
The API URL. Optional parameter that allows specifying a custom host for Meadow cloud services. If not set, the default production environment is used.
* `api_key`* - The API key for authenticating with Meadow's cloud services. This key should be kept secure.
* `collection_id`* - The ID of the device collection to which the package will be published. This ID specifies the target group of devices.
* `host` - The API URL. Optional parameter that allows specifying a custom host for Meadow cloud services. If not set, the default production environment is used.
* `metadata` - Metadata for the publish operation. Optional parameter that can be used to provide additional context or data for the publish operation.

### `metadata`
Metadata for the publish operation. Optional parameter that can be used to provide additional context or data for the publish operation.
_* required fields_

## How to Use
## Usage

To use this action, define it in your workflow YAML file with the necessary inputs. Below is an example workflow that demonstrates how to configure and use the Publish Meadow MPAK action:

Expand Down
35 changes: 11 additions & 24 deletions docs/Meadow/Meadow.Cloud/Automatic_Upload/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,24 @@ title: GitHub Action Upload
subtitle: Getting started
---

# Build and Upload Meadow MPAK Action
With GitHub Actions, you can automate the complete process of building, testing, and uploading Meadow MPAK files to Meadow.Cloud using [`meadow-cloud-package-upload`](https://github.com/WildernessLabs/meadow-cloud-package-upload) action. It provides an integrated solution for managing the deployment pipeline of Meadow-based applications.

This GitHub Action is designed for the complete process of building, testing, and uploading Meadow MPAK files to the cloud. It provides an integrated solution for managing the deployment pipeline of Meadow-based applications.

## Description

The "Deploy and Upload Meadow MPAK" action combines building, testing, packaging, and uploading processes into a single workflow. This ensures that your Meadow applications are compiled, tested, and deployed efficiently and consistently across your development team.
The **Deploy and Upload Meadow MPAK** action combines building, testing, packaging, and uploading processes into a single workflow. This ensures that your Meadow applications are compiled, tested, and deployed efficiently and consistently across your development team.

## Inputs

### `organization_id`
**Required** The identifier for your organization within Meadow's cloud services.

### `api_key`
**Required** The API key for authenticating with Meadow's cloud services.

### `os_version`
Optional. Specifies the operating system version for the Meadow device, allowing specific firmware versions to be targeted.

### `cli_version`
Optional. Specifies the version of the Meadow Command Line Interface (CLI) tool to use.

### `configs`
Optional. A JSON string of key-value pairs for replacing placeholders in `*.yaml` configuration files. Defaults to an empty object (`{}`).
* `organization_id`* - The identifier for your organization within Meadow's cloud services.
* `api_key`* - The API key for authenticating with Meadow's cloud services.
* `os_version` - Specifies the operating system version for the Meadow device, allowing specific firmware versions to be targeted.
* `cli_version` - Specifies the version of the [Meadow.CLI](../../Meadow_Tools/Meadow_CLI/index.md) tool to use.
* `configs` - A JSON string of key-value pairs for replacing placeholders in `*.yaml` configuration files. Defaults to an empty object (`{}`).
* `host` - The API URL for the Meadow cloud services. Allows the action to interface with different Meadow cloud environments.

### `host`
Optional. The API URL for the Meadow cloud services. Allows the action to interface with different Meadow cloud environments.
_* required fields_

## How to Use
## Usage

Below is an example of how to implement this action in a GitHub workflow:
To use this action, define it in your workflow YAML file with the necessary inputs. Below is an example of how to implement this action in a GitHub workflow:

```yaml
name: Continuous Deployment of Meadow MPAK
Expand Down

0 comments on commit ad1374b

Please sign in to comment.