Skip to content

Commit 77e7cbd

Browse files
authored
Merge pull request lxc#483 from stgraber/main
doc: Add support page and section introductions
2 parents bb3dc2b + 1f4a013 commit 77e7cbd

File tree

8 files changed

+70
-3
lines changed

8 files changed

+70
-3
lines changed

doc/.wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ EOF
1313
FAT
1414
formatters
1515
Furo
16+
FuturFusion
1617
GiB
1718
Github
1819
Incus

doc/getting-started.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
# Getting started
2+
Let's get you started with IncusOS!
3+
4+
Whether you want to run it on some physical hardware or in a virtual
5+
machine, you'll have to make sure your system meets the current system
6+
requirements, then get yourself an image and finally install it on your
7+
system.
28

39
```{toctree}
410
:maxdepth: 1

doc/reference.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# Reference
2+
This reference documentation covers every aspect of IncusOS.
3+
4+
It includes details for all installable applications, system services and general system configuration.
5+
In addition, it also provides some detailed background information on core features of IncusOS.
26

37
```{toctree}
48
:maxdepth: 1

doc/reference/applications.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
11
# Applications
2+
IncusOS itself doesn't listen on the network. For the system to be
3+
accessible and manageable over the network, it requires a primary
4+
application to be installed.
5+
6+
The primary application is responsible for listening on the network and
7+
for handling user authentication. It then provides access to the IncusOS
8+
management API through its own API.
9+
10+
IncusOS also supports additional (non-primary) applications which can
11+
extend the base system (for example for debugging) or provide additional
12+
features to another application.
213

314
```{toctree}
415
:maxdepth: 1

doc/reference/applications/shared-api.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ If needed, an application can be restarted by running
1010
incus admin os application restart <name>
1111
```
1212

13-
Note: It is expected to receive an EOF error since the application's HTTP REST endpoint will be restarted along with the application.
13+
```{note}
14+
It is expected to receive an EOF error since the application's HTTP REST endpoint will be restarted along with the application.
15+
```
1416

1517
## Backing up the application
1618

@@ -44,7 +46,9 @@ Restore the backup by running
4446
incus admin os application restore <name> backup.tar.gz
4547
```
4648

47-
Note: It is expected to receive an EOF error since the application's HTTP REST endpoint will be restarted along with the application after performing the restoration.
49+
```{note}
50+
It is expected to receive an EOF error since the application's HTTP REST endpoint will be restarted along with the application after performing the restoration.
51+
```
4852

4953
## Factory reset
5054

@@ -58,4 +62,6 @@ Reset the application by running
5862
incus admin os application factory-reset <name>
5963
```
6064

61-
Note: It is expected to receive an EOF error since the application's HTTP REST endpoint will be restarted along with the application after resetting the application.
65+
```{note}
66+
It is expected to receive an EOF error since the application's HTTP REST endpoint will be restarted along with the application after resetting the application.
67+
```

doc/reference/services.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Services
2+
IncusOS system services are optional system-wide features, typically
3+
used to integrate with an external system.
4+
5+
The majority of services today are centered around connecting to
6+
external storage or networking.
27

38
```{toctree}
49
:maxdepth: 1

doc/reference/system.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# System configuration
2+
IncusOS runs a management daemon which is responsible not just of
3+
starting and stopping the various applications and services but also of
4+
correctly bringing up system networking and storage, handle updates and
5+
manage encryption keys.
6+
7+
Those core system functions each have their own state and configuration
8+
as well as relevant actions.
29

310
```{toctree}
411
:maxdepth: 1

doc/support.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,28 @@
11
# Support
2+
## Releases
3+
IncusOS uses a rolling release model.
4+
5+
A new stable release is tagged at least once a week to pick up the latest bug fixes to the Linux kernel, Incus and any other component that we ship.
6+
7+
When reporting an issue, please first ensure that your system is running the latest stable release.
8+
9+
```{note}
10+
The use of other update channels like `testing` isn't supported and should be limited to development and debugging use on non-critical systems.
11+
```
12+
13+
## Support and community
14+
15+
The following channels are available for you to interact with the IncusOS community.
16+
17+
## Bug reports
18+
19+
You can file bug reports and feature requests at: [`https://github.com/lxc/incus-os/issues/new`](https://github.com/lxc/incus-os/issues/new)
20+
21+
## Community support
22+
23+
Community support is handled at: [`https://discuss.linuxcontainers.org`](https://discuss.linuxcontainers.org)
24+
25+
## Commercial support
26+
27+
Commercial support is currently available from [Zabbly](https://zabbly.com) for standalone IncusOS deployments.
28+
For large scale deployments of IncusOS, support can be obtained from [FuturFusion](https://futurfusion.io) as part of FuturFusion Cloud.

0 commit comments

Comments
 (0)