Commit d7a5fc2f authored by Mikhail Zolotukhin's avatar Mikhail Zolotukhin Committed by Carl Schwan
Browse files

Split the documentation into 3 level matryoshka categories

## Summary

This MR splits the docs into three categories according to the proposal in #64. This makes navigating to the tutorials for the different type of developers easier.

The three categories are:
- For the core devs, that build official KDE stuff
- For the extension developers, that make the various extensions: themes, plasmoids, KWin and Plasma scripts etc.
- For the external devs, that use KDE Frameworks and other tech in 3rd party projects, that do not necessary extend or develop the existing KDE tech (i.e. their product is not an extension for KDE project and not the official KDE project).

Each category assumes, that the reader may refer to the upper one, making some kind of matryoshka: the things external dev may know is inside the extension related thing, which is inside the core devs' category.

## Screenshots


![Screen_Shot_2021-11-23_at_19.25.07](/uploads/12452cd5f09452b5eea395e56d83879d/Screen_Shot_2021-11-23_at_19.25.07.png)

![Screen_Shot_2021-11-23_at_19.25.49](/uploads/0067271f8acdc5f8f9d730da11063622/Screen_Shot_2021-11-23_at_19.25.49.png)

![Screen_Shot_2021-11-23_at_19.26.49](/uploads/5d3741e250bd23666afa6cb964123eae/Screen_Shot_2021-11-23_at_19.26.49.png)

![Screen_Shot_2021-11-23_at_19.27.18](/uploads/c73655b7b038a185944d1015581be1ac/Screen_Shot_2021-11-23_at_19.27.18.png)

Fixes #64
parent fb403dad
......@@ -7,3 +7,5 @@ build/
tmp/
files/
content-trans
!content/docs/build/
......@@ -128,7 +128,7 @@ params:
navbar_logo: true
readingtime:
enable: false
sidebar_menu_compact: false
sidebar_menu_compact: true
sidebar_search_disable: false
url_latest_version: https://example.com
version: '0.0'
......
......@@ -2,17 +2,6 @@
---
title: "Documentation"
linkTitle: "Documentation"
layout: home
groups:
- name: "Getting Started"
key: getting-started
- name: "Features"
key: features
- name: "Packaging"
key: "packaging"
- name: "Application Extensions"
key: "applications"
menu:
main:
weight: 10
......
---
title: "Building KDE Technologies"
linkTitle: "Build KDE Tech"
weight: 3
description: >
Learn how to develop KDE technologies, that are used by 3rd-party and KDE Extensions' developers.
---
......@@ -4,6 +4,8 @@ linkTitle: "Distributing KDE Software as Flatpak"
description: "The new decentralized packaging standard for Linux applications"
weight: 20
group: "packaging"
---
aliases:
- /docs/flatpak/
---
This tutorial will guide you in creating, deploying, expanding and troubleshooting Flatpak packages so your application can be distributed to any distribution, quick and easy.
......@@ -2,6 +2,8 @@
title: Extending your package
description: Understand the core components of your manifest.
weight: 2
aliases:
- /docs/flatpak/manifest/
---
Let's first take a look at our previous manifest to understand what each thing does.
......
......@@ -2,6 +2,8 @@
title: Your first Flatpak
description: Learn how to create Flatpaks in three simple steps.
weight: 1
aliases:
- /docs/flatpak/packaging/
---
Flatpak is a new package format in the Linux world that works on many Linux
......
......@@ -2,6 +2,8 @@
title: Your app on kdeapps
description: How and where to publish your manifests
weight: 3
aliases:
- /docs/flatpak/publishing/
---
## Publishing on kdeapps
......
......@@ -2,6 +2,8 @@
title: Plasma Mobile
weight: 7
group: "features"
aliases:
- /docs/plasma-mobile/
SPDX-FileCopyrightText: 2021 Carl Schwan <carlschwan@kde.org>
SPDX-License-Identifier: CC-BY-SA-4.0
---
......
---
title: Porting a new device to Plasma Mobile
weight: 1
aliases:
- /docs/plasma-mobile/porting
SPDX-FileCopyrightText: 2021 Carl Schwan <carlschwan@kde.org>
SPDX-License-Identifier: CC-BY-SA-4.0
---
......
---
title: Execute Applications
weight: 3
aliases:
- /docs/plasma-mobile/running-apps
SPDX-FileCopyrightText: 2018 Jonah Brüchert <jbb.prv@gmx.de>
SPDX-License-Identifier: CC-BY-SA-4.0
---
......
......@@ -2,6 +2,8 @@
title: Plasma Mobile Telephony Stack
description: Architecture and general description
weight: 2
aliases:
- /docs/plasma-mobile/telephony/
SPDX-FileCopyrightText: 2021 Alexey Andreyev <aa13q@ya.ru>
SPDX-License-Identifier: CC-BY-SA-4.0
---
......
......@@ -2,6 +2,9 @@
title: KDE application layer
description: KDE Telephony stack
weight: 5
aliases:
- /docs/plasma-mobile/telephony/kde-application-layer/
SPDX-FileCopyrightText: 2021 Alexey Andreyev <aa13q@ya.ru>
SPDX-License-Identifier: CC-BY-SA-4.0
---
......
......@@ -4,6 +4,8 @@ description: KDE Telephony stack
weight: 1
SPDX-FileCopyrightText: 2021 Alexey Andreyev <aa13q@ya.ru>
SPDX-License-Identifier: CC-BY-SA-4.0
aliases:
- /docs/plasma-mobile/telephony/kernel-layer/
---
While the kernel side is not a scope of the KDE project, it could be helpful to get a general overview to support the higher levels of the KDE Telephony stack.
......
......@@ -4,6 +4,8 @@ description: KDE Telephony stack
weight: 4
SPDX-FileCopyrightText: 2021 Alexey Andreyev <aa13q@ya.ru>
SPDX-License-Identifier: CC-BY-SA-4.0
aliases:
- /docs/plasma-mobile/telephony/qml-declarative-plugin-layer/
---
[kde-telephony-plugin-declarative](https://invent.kde.org/plasma-mobile/plasma-dialer/-/tree/master/kde-telephony-plugin-declarative)`org.kde.telephony` QML plugin to work with the telephony daemon D-Bus interfaces.
......
......@@ -4,6 +4,8 @@ description: Userland D-Bus IPC, KDE Telephony stack
weight: 3
SPDX-FileCopyrightText: 2021 Alexey Andreyev <aa13q@ya.ru>
SPDX-License-Identifier: CC-BY-SA-4.0
aliases:
- /docs/plasma-mobile/telephony/session-daemon-userland-dbus-ipc-level/
---
ModemManager (or oFono previously) [provides](../system-daemon-userland-dbus-ipc-level) unified access to different modem devices with different command lists via system D-Bus IPC.
......
......@@ -4,6 +4,8 @@ description: Userland D-Bus IPC, KDE Telephony stack
weight: 2
SPDX-FileCopyrightText: 2021 Alexey Andreyev <aa13q@ya.ru>
SPDX-License-Identifier: CC-BY-SA-4.0
aliases:
- /docs/plasma-mobile/telephony/system-daemon-userland-dbus-ipc-level/
---
### General overview: oFono and ModemManager
......
......@@ -2,6 +2,8 @@
title: ModemManager Telephony functions
SPDX-FileCopyrightText: 2021 Alexey Andreyev <aa13q@ya.ru>
SPDX-License-Identifier: CC-BY-SA-4.0
aliases:
- /docs/plasma-mobile/telephony/system-daemon-userland-dbus-ipc-level/modem-manager/
---
[ModemManager](https://www.freedesktop.org/wiki/Software/ModemManager/) is a _GPL-2.0-or-later & LGPL-2.1-or-later_ FreeDesktop project [stated in the year 2008 with customer USB dongles support for the desktops](https://gitlab.freedesktop.org/mobile-broadband/ModemManager/-/commits/0.2.997/plugins). It integrates with the higher-level [NetworkManager](https://gitlab.freedesktop.org/NetworkManager/NetworkManager) network management daemon.
......
......@@ -2,6 +2,8 @@
title: oFono Telephony functions
SPDX-FileCopyrightText: 2021 Jonah Brüchert <jbb.mail@gmx.de>
SPDX-License-Identifier: CC-BY-SA-4.0
aliases:
- /docs/plasma-mobile/telephony/system-daemon-userland-dbus-ipc-level/modem-manager/
---
Plasma Mobile is currently switched from oFono to ModemManager.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment