Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
# TODO: If there's no such website,
# remove the {{ product_page }} link from the page header template
# (usually .sphinx/_templates/header.html; also, see README.rst).
"product_page": "https://ubuntu.com/core",
"product_page": "ubuntu.com/core",
# Product tag image; the orange part of your logo, shown in the page header
#
# TODO: To add a tag image, uncomment and update as needed.
Expand Down
5 changes: 2 additions & 3 deletions docs/explanation/community-engagement.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,8 @@ Both documentation and engineering teams agree to shoulder responsibilities impl

## Get in touch

You can find the Ubuntu Core team on both the Ubuntu Discourse forum and the Snapcraft forum:
- https://discourse.ubuntu.com/c/ubuntu-core-docs
- https://forum.snapcraft.io/c/snapd
You can find the Ubuntu Core team on the Snapcraft forum:
- [https://forum.snapcraft.io/c/snapd/5](https://forum.snapcraft.io/c/snapd/5)

For interactive discussions, the team can also be found on Matrix.org:
- https://matrix.to/#/#documentation:ubuntu.com
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Active: active (running) since Fri 2020-07-10 08:34:43 UTC; 2min 20s ago Main PI
Tasks: 3 (limit: 569)
CGroup: /system.slice/snap.modem-manager.modemmanager.service └─2047 /snap/modem-manager/414/usr/sbin/ModemManager --filter-policy=STRICT --log-level=INFO
```
Now you have ModemManager successfully installed. In the next sections we will briefly explain how to use part of ModemManager's features, using *mmcli* command line interface to interact with the service. For a complete reference on what can be done with ModemManager, take a look at [ *mmcli* man page](https://www.freedesktop.org/software/ModemManager/man/latest/mmcli.8.html) and to [ModemManager's D-Bus interface](https://www.freedesktop.org/software/ModemManager/api/latest/). It is also possible to use *dbus-send* to directly access the D-Bus interface if desired.
Now you have ModemManager successfully installed. In the next sections we will briefly explain how to use part of ModemManager's features, using *mmcli* command line interface to interact with the service. For a complete reference on what can be done with ModemManager, take a look at [ *mmcli* man page](https://www.freedesktop.org/software/ModemManager/man/latest/mmcli.1.html) and to [ModemManager's D-Bus interface](https://www.freedesktop.org/software/ModemManager/api/latest/). It is also possible to use *dbus-send* to directly access the D-Bus interface if desired.

Finally, note that to run both *mmcli* and *dbus-send* we need root permissions, so we use *sudo* with them.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Verify that everything is working and setup correctly by looking into the follow
- Docker containers: `docker ps`

You should be able to access the RabbitMQ's management dashboard via a web browser.
By default, it is available at http://localhost:15672 (username/password: `guest`).
By default, it is available at `http://localhost:15672` (username/password: `guest`).

![RabbitMQ Management Dashboard|800x397](https://assets.ubuntu.com/v1/616d2ae4-deploy-docker-from-a-snap.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,29 +1,27 @@
# Install on a device
# Deploy an image

We create pre-built Ubuntu Core images for several testing platforms. These images are a way to explore Ubuntu Core. Canonical produces official images for the [following platforms](https://ubuntu.com/core/docs/supported-platforms).

## Image writing

We recommend first users try pre-built Ubuntu Core images on a Raspberry Pi or Intel NUC, as these range of devices are easy to use and widely accessible.

- [Use Raspberry Pi imager](use-raspberry-pi-imager): install a pre-built Ubuntu Core image on a Raspberry Pi
- [Use the dd command](use-the-dd-command): write an Ubuntu Core reference image to internal storage

## Install on a specific device

We also provide instructions for building and installing an Ubuntu Core image on a specific device.

- [Install on a Renesas RZ/G2L](install-on-renesas): Install a pre-built testing image on a [Renesas RZ/G2L](https://www.renesas.com/en/products/microcontrollers-microprocessors/rz-mpus/rzg2l-general-purpose-mpu-dual-core-arm-cortex-a55-cpus-and-single-core-cortex-m33-cpu-3d-graphics-and)
- [Install on a MediaTek Genio](install-on-mediatek): Install a pre-built testing image on a [MediaTek Genio](https://www.mediatek.com/products/iot/genio-iot)

## Image writing

For generic devices, we recommend users try pre-built Ubuntu Core images on a Raspberry Pi or Intel NUC, as these range of devices are easy to use and widely accessible.

- [Use Raspberry Pi imager](/tutorials/try-pre-built-images/use-raspberry-pi-imager): install a pre-built Ubuntu Core image on a Raspberry Pi
- [Use the dd command](/tutorials/try-pre-built-images/use-the-dd-command): write an Ubuntu Core reference image to internal storage


```{toctree}
:hidden:
:titlesonly:
:maxdepth: 2
:glob:

Use Raspberry Pi imager <use-raspberry-pi-imager>
Use the dd command <use-the-dd-command>
Install on a Renesas RZ/G2L <install-on-renesas>
Install on a MediaTek Genio <install-on-mediatek>
12 changes: 10 additions & 2 deletions docs/how-to-guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ Any device running Ubuntu Core is instantiated from an image. This image contain

- [Create images](image-creation/index)

## Deploy an image

Pre-built image install guides for testing specific platforms, including devices from MediaTek and Renesas.

- [Install on a Renesas RZ/G2L](deploy-an-image/install-on-renesas/): Install a pre-built image on a Renesas RZ/G2L device
- [Install on a MediaTek Genio](deploy-an-image/install-on-mediatek/): Install a pre-built image on a MediaTek Genio device

## Manage Ubuntu Core

Maintain and manage your Ubuntu Core systems, including recovery modes, system users, configuration options and kernel options.
Expand All @@ -35,6 +42,7 @@ Ubuntu Core has been developed specifically to leverage the power of snap packag
:glob:

Using Ubuntu Core <using-ubuntu-core>
Create images <image-creation/index>
Create an image <image-creation/index>
Deploy an image <deploy-an-image/index>
Manage Ubuntu Core <manage-ubuntu-core/index>
Deploy containers <container-deployment/index>
Work with containers <container-deployment/index>
7 changes: 7 additions & 0 deletions docs/redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
# Example:
# redirect/from/file/ redirect/to/file/

# RTD reconfiguration

tutorials/try-pre-built-images/install-on-a-device/use-raspberry-pi-imager/ tutorials/try-pre-built-images/use-raspberry-pi-imager/
tutorials/try-pre-built-images/install-on-a-device/use-the-dd-command/ tutorials/try-pre-built-images/use-the-dd-command/
tutorials/try-pre-built-images/install-on-a-device/ how-to-guides/deploy-an-image/
tutorials/try-pre-built-images/install-on-a-device/install-on-renesas/ how-to-guides/deploy-an-image/install-on-renesas/
tutorials/try-pre-built-images/install-on-a-device/install-on-mediatek/ how-to-guides/deploy-an-image/install-on-mediatek/

# Old top level
uc24 reference/release-notes/
Expand Down
2 changes: 2 additions & 0 deletions docs/tutorials/build-your-first-image/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This same process can be used to build Ubuntu Core images for various hardware a

## Step-by-step guide



1. [Requirements](requirements)
1. [Create an Ubuntu One account](access-ubuntu-one)
1. [Create the account online](access-ubuntu-one.md#create-an-ubuntu-one-account)
Expand Down
7 changes: 2 additions & 5 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,9 @@ Ubuntu Core has been designed to facilitate the creation, deployment, and manag

A step-by-step guide to building and testing your own image with your own selection of applications.

## Install Ubuntu Core
## Try Ubuntu Core

Pre-built test images are also available for Renesas GZ/G2l and MediaTek Genio devices, alongside x86-based PC-style hardware and ARM-based platforms.


. These testing images are ideal for exploration and experimentation but they're not intended for deployment or for use at scale.
These testing images are ideal for exploration and experimentation but they're not intended for deployment or for use at scale.


* [Install and try a pre-built image](/tutorials/try-pre-built-images/index)
Expand Down
14 changes: 4 additions & 10 deletions docs/tutorials/try-pre-built-images/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,8 @@ You can try Ubuntu Core without any specific hardware from within a virtual mach

Ubuntu Core runs on a large range of hardware, and pre-built images are available for amd64 and Raspberry Pi reference platforms.

- [Use Raspberry Pi imager](install-on-a-device/use-raspberry-pi-imager): install a pre-built Ubuntu Core image on a Raspberry Pi
- [Use the dd command](install-on-a-device/use-the-dd-command): write an Ubuntu Core reference image to internal storage

## Install on a specific device

Pre-built test images are also available for Renesas GZ/G2L and MediaTek Genio devices.

- [Install on a Renesas RZ/G2L](install-on-a-device/install-on-renesas): Install a pre-built image on a Renesas RZ/G2L device <install-on-renesas>
- [Install on a MediaTek Genio](install-on-a-device/install-on-mediatek): Install a pre-built image on a MediaTek Genio device <install-on-mediatek>
- [Use Raspberry Pi imager](use-raspberry-pi-imager): install a pre-built Ubuntu Core image on a Raspberry Pi
- [Use the dd command](use-the-dd-command): write an Ubuntu Core reference image to internal storage


```{toctree}
Expand All @@ -36,4 +29,5 @@ Pre-built test images are also available for Renesas GZ/G2L and MediaTek Genio d
:glob:

Install on a VM <install-on-a-vm>
Install on a device <install-on-a-device/index>
Use Raspberry Pi Imager <use-raspberry-pi-imager>
Use the dd command <use-the-dd-command>