Merge pull request #245 from keirthana/update-landing-pages

Update landing pages to align with exemplar
canonical · Dec 11, 2024 · 285da7b · 285da7b
2 parents 4528693 + 94089a9
commit 285da7b
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 74 deletions.
diff --git a/explanation/landing.md b/explanation/landing.md
@@ -5,43 +5,45 @@ The explanatory and conceptual guides in this section provide a better understan
 
 ## Anbox Cloud: Architecture and components
 
-Understand the underlying architecture of Anbox Cloud, its variants and how the different components of Anbox Cloud relate to each other
-|  Guides | What they explain |
-|--|--|
-| {ref}`exp-anbox-cloud` | Differences between Anbox Cloud and the Anbox Cloud Appliance, explanation about the components and architecture of the offering |
-| {ref}`exp-ams` | The Anbox Management Service (AMS) and how it handles aspects of the application and life cycle of an instance |
-| {ref}`exp-aar` | The Anbox Application Registry (AAR) and what it does|
-| {ref}`exp-application-streaming` | Architecture of the Streaming Stack and supported video codecs |
-| {ref}`exp-rendering-architecture` | Different rendering pipelines for supported GPUs |
+Understand the underlying architecture of Anbox Cloud, its variants and how the different components of Anbox Cloud relate to each other.
+
+* {ref}`exp-anbox-cloud`
+* {ref}`exp-ams`
+* {ref}`exp-aar`
+* {ref}`exp-web-dashboard`
+* {ref}`exp-application-streaming`
+* {ref}`exp-rendering-architecture`
 
 ## Working with Anbox Cloud
 
 Understand the different objects used in the product stack and how to use them to tune the performance of Anbox Cloud.
-| Guides  | What they explain  |
-|--|--|
-| {ref}`exp-applications` | Application requirements and the application bootstrap process |
-| {ref}`exp-instances` | Learn about an instance and its life cycle |
-| {ref}`exp-images` | Learn about an image and its relationship with an instance |
-| {ref}`exp-nodes` | Learn about a node and its purposes |
-| {ref}`exp-addons` | Learn about an addon and best practices for using it |
-| {ref}`exp-web-dashboard` | The capabilities provided by the Anbox Cloud dashboard |
-| {ref}`exp-aaos` | Anbox Cloud's support for Android Automotive OS (AAOS) images |
-| {ref}`exp-platforms` | Configuring supported platforms |
-| {ref}`exp-clustering` | Clustering and managing the load over multiple machines|
-| {ref}`exp-performance` | Aspects that are relevant for tuning the performance of Anbox Cloud |
+
+* {ref}`exp-applications`
+* {ref}`exp-instances`
+* {ref}`exp-images`
+* {ref}`exp-nodes`
+* {ref}`exp-addons`
+* {ref}`AAOS <exp-aaos>`
+* {ref}`exp-platforms`
+* {ref}`exp-clustering`
 
 ## Deploying Anbox Cloud
 
 Understand deployment configurations to plan your deployment.
-| Guides | What they explain  |
-|--|--|
-| {ref}`exp-production-planning` | Aspects to consider for best results when you are planning a production deployment |
-| {ref}`exp-capacity-planning` | How to estimate the required capacity for your Anbox Cloud deployment |
-| {ref}`exp-rendering-graphics` | Rendering graphical output |
-| {ref}`exp-security` | Important aspects to keep your Anbox Cloud deployment secure |
-| {ref}`exp-security-landing` | The cryptographic technology used by various Anbox Cloud components |
-| {ref}`exp-resources-presets` | Learn about resource presets and how to customise required resources for applications |
-| {ref}`exp-custom-images` | Learn about customising AAOS images |
+
+* {ref}`exp-production-planning`
+* {ref}`exp-capacity-planning`
+* {ref}`exp-rendering-graphics`
+* {ref}`exp-resources-presets`
+* {ref}`exp-custom-images`
+* {ref}`exp-performance`
+
+## Security with Anbox Cloud
+
+Understand how you can deploy Anbox Cloud secure, the cryptography information used by various Anbox Cloud components.
+
+* {ref}`Security <exp-security>`
+* {ref}`exp-security-landing`
 
 
 Also check out the {ref}`tutorials` for step-by-step instructions that help you get familiar with Anbox Cloud, the {ref}`how-to-guides` for instructions on how to achieve specific goals when using Anbox Cloud and the {ref}`reference` section for reference material.

diff --git a/howto/anbox/landing.md b/howto/anbox/landing.md
@@ -13,4 +13,4 @@ Run benchmarks <benchmarks>
 Set up TLS <tls-for-appliance>
 ```
 
-You can also refer to {ref}`ref-appliance-commands` and {ref}`ref-amc-commands` for commands that you can use with the CLI.
+You can also refer to {ref}`ref-cmd-ref` for commands that you can use with the CLI.
diff --git a/howto/landing.md b/howto/landing.md
@@ -3,9 +3,9 @@
 
 The *How-to* guides in this section give directions on how to achieve your goals when configuring, managing or using Anbox Cloud. These *How-to*  guides are more useful when you are familiar with Anbox Cloud and seek to achieve specific tasks. They help you complete your tasks but may require you to understand and adapt the steps to fit your specific requirements.
 
-## Installing and configuring Anbox Cloud
+## Installation and deployment
 
-Learn how to install, configure and update Anbox Cloud.
+Learn how to install, configure and upgrade Anbox Cloud.
 
 * {ref}`howto-install-anbox-cloud`
 * {ref}`howto-install-appliance`
@@ -15,12 +15,13 @@ Learn how to install, configure and update Anbox Cloud.
 
 Learn about applications, instances and more in Anbox Cloud and how to use them.
 
-* {ref}`howto-port-android-apps`
 * {ref}`howto-manage-applications`
 * {ref}`howto-instance`
 * {ref}`howto-addons`
 * {ref}`howto-streaming`
+* {ref}`howto-port-android-apps`
 * {ref}`howto-use-web-dashboard`
+* {ref}`howto-Android`
 
 ## Managing Anbox Cloud
 

diff --git a/reference/cmd-ref/landing.md b/reference/cmd-ref/landing.md
@@ -1,3 +1,4 @@
+(ref-cmd-ref)=
 # Command reference
 
 This section provides command reference for the following command line utilities:

diff --git a/reference/landing.md b/reference/landing.md
@@ -5,74 +5,73 @@ The reference guides in this section provide additional information about using
 
 ## Releases and versions
 
-Learn about Anbox Cloud releases, release roadmap, deprecations, supported product versions and component versions.
+Learn about Anbox Cloud releases, the product roadmap, deprecations, supported product versions and component versions.
 
-| Guides | Description  |
-|--|--|
-| {ref}`ref-release-notes` | Release notes for all versions of Anbox Cloud, information about supported versions, release cycle, and future releases |
-| {ref}`ref-deprecation-notes` | Deprecation notices for Anbox Cloud and its components |
-| {ref}`ref-component-versions` | Version information about different components of Anbox Cloud for each release |
+* {ref}`ref-release-notes`
+* {ref}`ref-deprecation-notes`
+* {ref}`ref-component-versions`
 
 ## Usage
 
 Understand the difference aspects of using Anbox Cloud such as requirements, supported features, provided SDKs, images, APIs, available network ports for communication, extending Anbox Cloud through addons and hooks.
 
-| Guides | Description  |
-|--|--|
-| {ref}`ref-requirements`| Hardware and software requirements to use Anbox Cloud |
-| {ref}`ref-provided-images`| A list of official images that Anbox Cloud provides |
-| {ref}`ref-rendering-resources`| A list of supported GPU vendors, drivers, platforms, APIs etc. |
-| {ref}`ref-codecs`| A list of supported video codecs |
-| {ref}`ref-android-features`| Overview of Android features and which of them are supported by Anbox Cloud |
-| {ref}`ref-aosp-aaos`| Supported features for AOSP vs AAOS images as well as feature flags for enabling some features |
-| {ref}`ref-api`| APIs that Anbox Cloud provides |
-| {ref}`ref-sdks`| Overview of the SDKs that Anbox Cloud provides to facilitate integrating and extending the solution |
-| {ref}`ref-network-ports`| A list of network ports that Anbox Cloud exposes for each service |
-| {ref}`ref-addon-manifest`| List of keys in the addon manifest |
-| {ref}`ref-hooks`| Information about hooks for addons or applications and related environment variables |
+* {ref}`ref-requirements`
+* {ref}`Anbox Cloud images <ref-provided-images>`
+* {ref}`ref-rendering-resources`
+* {ref}`ref-codecs`
+* {ref}`ref-android-features`
+* {ref}`AOSP vs AAOS images <ref-aosp-aaos>`
+* {ref}`ref-sdks`
+* {ref}`ref-network-ports`
+* {ref}`ref-addon-manifest`
+* {ref}`ref-hooks`
 
 ## Configuration
 
 Know the configuration options that can be defined for various components of Anbox Cloud.
 
-| Guides | Description |
-|--|--|
-| {ref}`ref-appliance-preseed-config`| The Anbox Cloud Appliance preseed configuration format |
-| {ref}`ref-ams-configuration`| Configuration options for Anbox Management Service (AMS) |
-| {ref}`ref-application-manifest`| A list of attributes that can be specified in the application manifest |
-| {ref}`ref-webrtc`| Configuration details for the WebRTC streamer |
+* {ref}`Appliance preseed configuration <ref-appliance-preseed-config>`
+* {ref}`ref-ams-configuration`
+* {ref}`Appliance configuration <ref-appliance-configuration>`
+* {ref}`ref-application-manifest`
+* {ref}`ref-webrtc`
+
+## API reference
+
+Learn about the APIs provided by Anbox cloud.
+
+* {ref}`ref-api`
+  - [AMS HTTP API](https://documentation.ubuntu.com/anbox-cloud/en/latest/reference/api-reference/ams-api/)
+  - [Anbox HTTPS API](https://documentation.ubuntu.com/anbox-cloud/en/latest/reference/api-reference/anbox-https-api/)
+  - [Anbox Platform API](https://canonical.github.io/anbox-cloud.github.com/latest/anbox-platform-sdk/) 
+  - [Stream Gateway API](https://documentation.ubuntu.com/anbox-cloud/en/latest/reference/api-reference/gateway-api/)
+
 
 ## Command reference
 
 Learn about the commands and their usage for the Anbox Management Client (AMC) and the Anbox Cloud Appliance.
 
-| Guides | Description |
-|--|--|
-| {ref}`ref-amc-commands`| Commands and their usage when using the AMC |
-| {ref}`ref-appliance-commands`| Commands and their usage when using the appliance |
+* [AMC commands](./cmd-ref/amc/ams.amc.md)
+* [Appliance commands](./cmd-ref/appliance/anbox-cloud-appliance.md)
 
 ## Performance
 
 Learn about the available metrics and benchmarks for measuring performance.
-| Guides | Description |
-|--|--|
-| {ref}`ref-prometheus-metrics`| Performance metrics that Anbox Cloud provides |
-| {ref}`ref-performance-benchmarks`| Benchmarks for the performance that you can achieve with different versions and configurations of Anbox Cloud |
+
+* {ref}`ref-prometheus-metrics`
+* {ref}`ref-performance-benchmarks`
 
 ## Security
 
 Learn about our security policies and about the fixes we have provided for vulnerabilities.
-|Guides | Description |
-|--|--|
-| {ref}`ref-security-notices`| Details on the CVEs we have fixed |
-| {ref}`ref-security-policy` | Anbox Cloud security policy and reporting a vulnerability |
+
+* {ref}`ref-security-notices`
+* {ref}`ref-security-policy`
 
 ## Other
 
-| Guides | Description |
-|--|--|
-| {ref}`ref-license-information`| Information on where to find the licenses of components used by Anbox Cloud |
-| {ref}`ref-glossary`| Useful terminology for working with Anbox Cloud |
+* {ref}`ref-license-information`
+* {ref}`ref-glossary`
 
 Also check out the {ref}`tutorials` for step-by-step instructions that help you get familiar with Anbox Cloud, the {ref}`how-to-guides` for instructions on how to achieve specific goals when using Anbox Cloud and the {ref}`explanation` section for background information.