Skip to content

Commit

Permalink
Refactor tutorial classification: use downloadable and built-in:
Browse files Browse the repository at this point in the history
Updated tutorial classification to use `downloadable` and `built-in` categories instead of `external` and `built-in` for better clarity.

Restruct downloadable tutorials for better readability.
  • Loading branch information
Heeam-Shin committed Sep 11, 2024
1 parent c7afb1e commit a667d79
Show file tree
Hide file tree
Showing 33 changed files with 1,546 additions and 95 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ $ ares-install ./com.dual.webapp.sample_1.0.0_all.ipk -d [your-target-device]
```

{{< note >}}
For more details on the above procedure, refer to [Developing External Web Apps]({{< relref "developing-external-web-apps" >}}).
For more details on the above procedure, refer to [Developing Downloadable Web Apps]({{< relref "developing-downloadable-web-apps" >}}).
{{< /note >}}

If the installation succeed, the app card of the installed sample appears in Home Launcher.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Security Guide
date: 2022-12-02
date: 2024-09-10
weight: 40
toc: true
---
Expand Down Expand Up @@ -92,8 +92,8 @@ The following table shows the files related to ACG and trust level.
<td rowspan="2"><p>No need to set up. Trust level is set to <code>OEM</code> automatically.</p></td>
</tr>
<tr>
<td><p>External Service</p></td>
<td><p>Set up the <code>requiredPermissions</code> property in <a href="/docs/guides/development/configuration-files/appinfo-json/">appinfo.json</a> of the app packaged with the external service.</p></td>
<td><p>Downloadable Service</p></td>
<td><p>Set up the <code>requiredPermissions</code> property in <a href="/docs/guides/development/configuration-files/appinfo-json/">appinfo.json</a> of the app packaged with the downloadable service.</p></td>
</tr>
<tr>
<td><p>Built-in Service</p></td>
Expand All @@ -103,13 +103,13 @@ The following table shows the files related to ACG and trust level.
</table>
</div>

### For Apps and External Services
### For Apps and Downloadable Services

If you develop apps or external services, all you need to do is set up the `appinfo.json` file.
If you develop apps or downloadable services, all you need to do is set up the `appinfo.json` file.

1. Make a list of services --- which can be LS2 APIs or custom services.
2. Find ACG values for each service. See [Appendix. How to Find ACG Values of APIs](#appendix-how-to-find-acg-values-of-apis).
3. Add the ACG values to the `requiredPermissions` property in `appinfo.json`. In case of external services, use the `appinfo.json` file of the app packaged together with the service.
3. Add the ACG values to the `requiredPermissions` property in `appinfo.json`. In case of downloadable services, use the `appinfo.json` file of the app packaged together with the service.
4. Then app installer service automatically generates the configuration files during installation of your app or service.

The following example shows how to set up an ACG value at the `appinfo.json` file. This app can access to services whose ACG value is `acg3`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: JS Service Development Workflow
date: 2018-05-12
date: 2024-09-10
weight: 20
toc: true
---

This page outlines the steps to develop JS services for webOS Open Source Edition (OSE).

## External JS Services
## Downloadable JS Services

To develop an external JS service, the Command-Line Interface (CLI) tool is used.
To develop a downloadable JS service, the Command-Line Interface (CLI) tool is used.

In general, the steps described in [CLI Workflow]({{< relref "cli-user-guide#cli-workflow" >}}) are applied.

For a step-by-step tutorial, see [Developing External JS Services]({{< relref "developing-external-js-services" >}}).
For a step-by-step tutorial, see [Developing Downloadable JS Services]({{< relref "developing-downloadable-js-services" >}}).

## Built-in JS Services

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Overview
date: 2018-05-12
date: 2024-09-10
weight: 10
toc: true
---
Expand Down Expand Up @@ -30,13 +30,13 @@ Node.js was originally created as a framework for server-side JavaScript applica

In a webOS system, JS services are categorized by the packaging/delivery method as follows:

- **External JS Service**
- **Downloadable JS Service**
- The JS service is installed on the webOS target device.
- This approach helps 3<sup>rd</sup> party developers to create a JS service running on webOS devices.
- **Built-in JS Service**
- The JS service is built into the webOS image.
- This approach is used by platform developers and contributors to add a JS service that enhances the functionality of the platform.

{{< note >}}
Currently, an external JS service must be packaged within a web app.
Currently, a downloadable JS service must be packaged within a web app.
{{< /note >}}
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Native App Development Workflow
date: 2020-01-17
date: 2024-09-10
weight: 20
toc: true
---

This page outlines the steps to develop native apps for webOS Open Source Edition (OSE).

## External Native Apps
## Downloadable Native Apps

Developing an external native app requires the following steps:
Developing a downloadable native app requires the following steps:

1. Implement

Expand All @@ -33,7 +33,7 @@ Developing an external native app requires the following steps:
- Installing the app on the target using the CLI
- Launching the app

For a step-by-step tutorial with detailed instructions, see [Developing External Native Apps]({{< relref "developing-external-native-apps" >}}).
For a step-by-step tutorial with detailed instructions, see [Developing Downloadable Native Apps]({{< relref "developing-downloadable-native-apps" >}}).

## Built-in Native Apps

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Native Service Development Workflow
date: 2020-03-13
date: 2024-09-10
weight: 20
toc: true
---

This page outlines the steps to develop native services for webOS Open Source Edition (OSE).

## External Native Services
## Downloadable Native Services

Developing an external native service requires the following steps:
Developing a downloadable native service requires the following steps:

1. Implement

Expand All @@ -34,7 +34,7 @@ Developing an external native service requires the following steps:
- Installing the service on the target using the CLI
- Launching the dummy app or entering commands using a terminal

For a step-by-step tutorial with detailed instructions, see [Developing External Native Services]({{< relref "developing-external-native-services" >}}).
For a step-by-step tutorial with detailed instructions, see [Developing Downloadable Native Services]({{< relref "developing-downloadable-native-services" >}}).

## Built-in Native Services

Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: QML App Development Workflow
date: 2020-01-16
date: 2024-09-10
weight: 20
toc: true
---

This page outlines the steps to develop QML apps for webOS Open Source Edition (OSE).

## External QML Apps
## Downloadable QML Apps

To develop an external QML app, the Command-Line Interface (CLI) tool is used.
To develop a downloadable QML app, the Command-Line Interface (CLI) tool is used.

In general, the steps described in [CLI Workflow]({{< relref "cli-user-guide#cli-workflow" >}}) are applied.

For a step-by-step tutorial, see [Developing External QML Apps]({{< relref "developing-external-qml-apps" >}}).
For a step-by-step tutorial, see [Developing Downloadable QML Apps]({{< relref "developing-downloadable-qml-apps" >}}).

## Built-in QML Apps

Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: Web App Development Workflow
date: 2018-05-12
date: 2024-09-10
weight: 20
toc: true
---

This page outlines the steps to develop web apps for webOS Open Source Edition (OSE).

## External Web Apps
## Downloadable Web Apps

To develop an external web app, the Command-Line Interface (CLI) tool is used.
To develop a downloadable web app, the Command-Line Interface (CLI) tool is used.

In general, the steps described in [CLI Workflow]({{< relref "cli-user-guide#cli-workflow" >}}) are applied.

For a step-by-step tutorial, see [Developing External Web Apps]({{< relref "developing-external-web-apps" >}}).
For a step-by-step tutorial, see [Developing Downloadable Web Apps]({{< relref "developing-downloadable-web-apps" >}}).

## Built-in Web Apps

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Overview
date: 2020-09-29
date: 2024-09-10
weight: 10
toc: true
---
Expand Down Expand Up @@ -28,7 +28,7 @@ For details, see [Architecture Overview]({{< relref "architecture-overview" >}})

In a webOS system, web apps are categorized by the packaging/delivery method as follows:

- **External Web App**
- **Downloadable Web App**
- The web app is installed on the webOS target device.
- This approach helps 3<sup>rd</sup> party developers to create a web app running on webOS devices.
- **Built-in Web App**
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/guides/getting-started/hello-webos-ose.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Hello, webOS OSE!"
date: 2022-12-27
date: 2024-09-10
weight: 10
toc: true
---
Expand Down Expand Up @@ -40,18 +40,18 @@ You need to create an image for the desired target and prepare the target enviro

## Your First webOS OSE App

If you finished setting up the environment, it's time to start developing your first app running on webOS OSE, which will be an external web app.
If you finished setting up the environment, it's time to start developing your first app running on webOS OSE, which will be a downloadable web app.

### Install CLI

To develop an external web app, you will use Command-Line Interface (CLI), which is provided as a part of webOS OSE SDK. You can also use CLI to develop external JavaScript (JS) services.
To develop a downloadable web app, you will use Command-Line Interface (CLI), which is provided as a part of webOS OSE SDK. You can also use CLI to develop downloadable JavaScript (JS) services.

Proceed to [install CLI]({{< relref "cli-user-guide#installing-cli" >}}) for your operating system.

### Develop the External Web App
### Develop the Downloadable Web App

Follow the steps described in the [Developing External Web Apps]({{< relref "developing-external-web-apps" >}}) tutorial.
Follow the steps described in the [Developing Downloadable Web Apps]({{< relref "developing-downloadable-web-apps" >}}) tutorial.

## What's Next

* If you are interested in developing an external JS service, which will be packaged along with the web app you've just created, check the [Developing External JS Services]({{< relref "developing-external-js-services" >}}) tutorial.
* If you are interested in developing a downloadable JS service, which will be packaged along with the web app you've just created, check the [Developing Downloadable JS Services]({{< relref "developing-downloadable-js-services" >}}) tutorial.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Bring-Up Overview
date: 2024-03-18
date: 2024-09-10
weight: 10
toc: true
---
Expand Down Expand Up @@ -59,7 +59,7 @@ Once you've done the bring-up process, you can go through the following checklis

1. Swipe up the display and check whether Home Launcher is displayed.
2. Click the apps in Home Launch and check whether the apps are launched properly.
3. Check whether the sample native app is working properly. For details on how to install and run the sample app, see [Developing External Native Apps](/docs/tutorials/native-apps/developing-external-native-apps/).
3. Check whether the sample native app is working properly. For details on how to install and run the sample app, see [Developing Downloadable Native Apps](/docs/tutorials/native-apps/developing-downloadable-native-apps/).

{{< note >}}
You can verify the basic operation of LSM, WAM, System and Application Manager (SAM) using the following command:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Native Development Kit Setup
date: 2023-03-28
date: 2024-09-10
weight: 90
toc: true
---

To build [external native apps]({{< relref "developing-external-native-apps" >}}) or [services]({{< relref "developing-external-native-services" >}}) for webOS Open Source Edition (OSE), you need to install Native Development Kit (NDK) on your computer.
To build [downloadable native apps]({{< relref "developing-downloadable-native-apps" >}}) or [services]({{< relref "developing-downloadable-native-services" >}}) for webOS Open Source Edition (OSE), you need to install Native Development Kit (NDK) on your computer.

The NDK is a set of tools that include toolchains, libraries, and header files. This guide describes how to build and install the NDK on your computer.

Expand Down Expand Up @@ -94,7 +94,7 @@ Output messages might or might not be displayed depending on your computer's set
## Next Steps

Now you ready to build external native apps or services. Check the following guides:
Now you ready to build downloadable native apps or services. Check the following guides:

- [Developing External Native Apps]({{< relref "developing-external-native-apps">}})
- [Developing External Native Services]({{< relref "developing-external-native-services">}})
- [Developing Downloadable Native Apps]({{< relref "developing-downloadable-native-apps">}})
- [Developing Downloadable Native Services]({{< relref "developing-downloadable-native-services">}})
12 changes: 6 additions & 6 deletions content/en/docs/home/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,12 @@ <h1 class="title">Documentation Overview</h1>
</header>
<div class="card-content link-card-content">
<div class="content">
<p class="subtxt">Check out tutorials for developing external apps and services.</p>
<p><a href="{{< relref "developing-external-web-apps" >}}">External Web Apps</a></p>
<p><a href="{{< relref "developing-external-js-services" >}}">External JS Services</a></p>
<p><a href="{{< relref "developing-external-qml-apps" >}}">External QML Apps</a></p>
<p><a href="{{< relref "developing-external-native-apps" >}}">External Native Apps</a></p>
<p><a href="{{< relref "developing-external-native-services" >}}">External Native Services</a></p>
<p class="subtxt">Check out tutorials for developing downloadable apps and services.</p>
<p><a href="{{< relref "developing-downloadable-web-apps" >}}">Downloadable Web Apps</a></p>
<p><a href="{{< relref "developing-downloadable-js-services" >}}">Downloadable JS Services</a></p>
<p><a href="{{< relref "developing-downloadable-qml-apps" >}}">Downloadable QML Apps</a></p>
<p><a href="{{< relref "developing-downloadable-native-apps" >}}">Downloadable Native Apps</a></p>
<p><a href="{{< relref "developing-downloadable-native-services" >}}">Downloadable Native Services</a></p>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/tools/sdk/cli/cli-release-notes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Release Notes
display_title: Command-Line Interface Release Notes
date: 2024-07-17
date: 2024-09-10
weight: 20
toc: true
two_depth_toc: true
Expand Down Expand Up @@ -429,7 +429,7 @@ This version is compatible with **webOS OSE 2.0.0**. See below for the new, chan
### Known Issues

* When you install or uninstall an app using `ares-install`, a running Home Launcher disappears from the screen. To make the app listed on Home Launcher, you must reboot the target device.
* After rebooting the target device, the external app is listed on Home Launcher, but the icon of the app is not displayed.
* After rebooting the target device, the downloadable app is listed on Home Launcher, but the icon of the app is not displayed.

## v1.9.4 (June 2019)

Expand Down
Loading

0 comments on commit a667d79

Please sign in to comment.