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
6 changes: 6 additions & 0 deletions docs/explanation/how-snaps-work/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Explanatory and conceptual guides for snap packages - discussion and clarification of key topics for snap users and snap package developers, including how snaps work, interface connections, update management and security.
---

(explanation-how-snaps-work-index)=
# How snaps work

Expand Down
6 changes: 6 additions & 0 deletions docs/explanation/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Explanatory and conceptual guides for snap packages - discussion and clarification of key topics for snap users and snap package developers, including how snaps work, interface connections, update management and security.
---

(explanation-index)=
# Explanation

Expand Down
7 changes: 6 additions & 1 deletion docs/explanation/interfaces/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
myst:
html_meta:
description: Explanations of how the snap interface system works, including how interfaces are used to manage access to resources, and how interface hooks can be used to control what happens when an interface is used.
---

(explanation-interfaces-index)=
# Interfaces


As you begin to use snaps more, interfaces can be used to carefully permit and limit access to resources.

* {ref}`All about interfaces <explanation-interfaces-all-about-interfaces>`: The permission system used to manage access to resources.
Expand Down
6 changes: 6 additions & 0 deletions docs/explanation/security/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Learn about how snaps use standard Linux security policies to isolate themselves from the system, and from each other. Understand snap confinement, security policies and the snapd release process.
---

(explanation-security-index)=
# Security

Expand Down
6 changes: 6 additions & 0 deletions docs/how-to-guides/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Step-by-step guides covering key operations and common tasks for snap users and snap package developers, including how to manage updates, connect interfaces, control services and more.
---

(how-to-guides-index)=
# How-to guides

Expand Down
6 changes: 6 additions & 0 deletions docs/how-to-guides/manage-snaps/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Step-by-step guides on how to manage snap packages - control when snaps update, connect interfaces, set system options, control services and more for snap users and snap package developers.
---

(how-to-guides-manage-snaps-index)=
# Manage snaps

Expand Down
6 changes: 6 additions & 0 deletions docs/how-to-guides/snap-development/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Extend snap functionality with API access, internal tools, and customised environments for your applications and devices. Learn how to use the SnapD REST API, snapctl, test snapd fixes, debug snaps, use snap try and in-development features.
---

(how-to-snap-development)=
# Snap development

Expand Down
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Official snap packaging documentation - comprehensive guides for installation, configuration, security, package updates and removal management, alongside technical details on all snap packaging features for snap users and snap package developers.
---

(ref-index_snap-documentation)=
# Snap documentation

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/administration/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Deepen your understanding of how snaps can run on all kinds of devices, in all kinds of environments. Learn about system options, data locations, distribution support, network requirements and more for snap users and snap package developers.
---

(reference-administration-index)=
# Administration

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/development/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Extend snap functionality with API access and customised environments for your applications and devices. Learn about environment variables, the SnapD REST API, YAML schemas and more for snap users and snap package developers.
---

(reference-development-index)=
# Development

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/development/yaml-schemas/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: YAML schemas for snap packages, including the snap.yaml format, and the gadget and kernel snap formats for device development.
---

(reference-development-yaml-schemas-index)=
# YAML schemas

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Complete reference documentation for snap packages - technical details on all snap packaging features for snap users and snap package developers, including the snapd REST API, YAML schemas, system architecture and more.
---

(reference-index)=
# Reference

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/interfaces/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Every snap interface in a single place. Learn about the interfaces available to snap users and snap package developers, including how they work, how to use them, and how to manage them.
---

(ref-index_interfaces)=
# Interfaces

Expand Down
7 changes: 7 additions & 0 deletions docs/tutorials/get-started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
description: Learn how to list, find, install, run, update and remove snap packages with a hands-on introduction to using snap packages for new users.
---


(tutorials-get-started)=
# Get started

Expand Down
6 changes: 6 additions & 0 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Getting started with snap packages - learn how to install the snap daemon, and install and configure your first snap packages with step-by-step tutorials.
---

(tutorials-index)=
# Tutorials

Expand Down
6 changes: 6 additions & 0 deletions docs/tutorials/install-the-daemon/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: Installation instructions for the snap daemon (snapd) - the background service that manages and maintains your snaps. Snapd is pre-installed on many Linux distributions, and easy to install on most others. Find installation instructions for your distribution here.
---

(tutorials-install-the-daemon-index)=
# Install the daemon

Expand Down
Loading