Skip to content

Commit 97a9421

Browse files
authored
Make explanation section more consistent with how-tos (#229)
* Make explanation section more consistent with how-tos * Fill empty descriptions * Fix broken links
1 parent c137387 commit 97a9421

16 files changed

+405
-188
lines changed

explanation/active-directory.rst

+27-11
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,33 @@
33
Active Directory integration
44
*****************************
55

6-
* :ref:`Choosing an integration method <choosing-an-integration-method>`
7-
* :ref:`Security identifiers (SIDs) <security-identifiers-sids>`
8-
* :ref:`Identity Mapping (idmap) backends <identity-mapping-idmap-backends>`
9-
* :ref:`The rid idmap backend <the-rid-idmap-backend>`
10-
* :ref:`The autorid idmap backend <the-autorid-idmap-backend>`
6+
If you have a Microsoft Active Directory domain set up, you can join your
7+
Ubuntu Server to it.
8+
9+
Introduction
10+
============
11+
12+
.. toctree::
13+
:titlesonly:
14+
15+
intro-to/AD-integration
16+
17+
Configuration
18+
=============
19+
20+
This section will talk you through the options available and help you make the
21+
appropriate choices for your setup.
1122

1223
.. toctree::
13-
:hidden:
24+
:titlesonly:
25+
26+
Choosing an integration method <active-directory/choosing-an-integration-method>
27+
Security identifiers (SIDs) <active-directory/security-identifiers-sids>
28+
Identity Mapping (idmap) backends <active-directory/identity-mapping-idmap-backends>
29+
The rid idmap backend <active-directory/the-rid-idmap-backend>
30+
The autorid idmap backend <active-directory/the-autorid-idmap-backend>
31+
32+
See also
33+
========
1434

15-
Choosing an integration method <active-directory/choosing-an-integration-method>
16-
Security identifiers (SIDs) <active-directory/security-identifiers-sids>
17-
Identity Mapping (idmap) backends <active-directory/identity-mapping-idmap-backends>
18-
The rid idmap backend <active-directory/the-rid-idmap-backend>
19-
The autorid idmap backend <active-directory/the-autorid-idmap-backend>
35+
* How-to: :ref:`how-to-active-directory-integration`

explanation/cryptography.rst

+12-8
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,19 @@
33
Cryptography
44
*************
55

6-
* :ref:`OpenSSL <openssl>`
7-
* :ref:`GnuTLS <gnutls>`
8-
* :ref:`Network Security Services (NSS) <network-security-services-nss>`
9-
* :ref:`Java cryptography configuration <java-cryptography-configuration>`
10-
* :ref:`BIND 9 DNSSEC cryptography selection <bind-9-dnssec-cryptography-selection>`
11-
* :ref:`OpenSSH crypto configuration <openssh-crypto-configuration>`
12-
* :ref:`Troubleshooting TLS/SSL <troubleshooting-tls-ssl>`
6+
.. toctree::
7+
:titlesonly:
8+
9+
intro-to/crypto-libraries
10+
11+
Common crypto libraries
12+
=======================
13+
14+
These pages discuss various popular cryptographic libraries that are commonly
15+
found in Ubuntu.
1316

1417
.. toctree::
15-
:hidden:
18+
:titlesonly:
1619

1720
OpenSSL <crypto/openssl>
1821
GnuTLS <crypto/gnutls>
@@ -21,3 +24,4 @@ Cryptography
2124
BIND 9 DNSSEC cryptography selection <crypto/bind-9-dnssec-cryptography-selection>
2225
OpenSSH crypto configuration <crypto/openssh-crypto-configuration>
2326
Troubleshooting TLS/SSL <crypto/troubleshooting-tls-ssl>
27+

explanation/data-and-storage.rst

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. _explanation-data-and-storage:
2+
3+
Data and storage
4+
****************
5+
6+
The following sections provide details on various topics related to storing,
7+
managing and accessing data.
8+
9+
Data management
10+
===============
11+
12+
OpenLDAP is a popular implementation of the Lightweight Directory Access
13+
Protocol (LDAP), used for managing hierarchical data.
14+
15+
.. toctree::
16+
:titlesonly:
17+
18+
intro-to/openldap
19+
20+
Databases are also a common data management tool in any setup.
21+
22+
.. toctree::
23+
:titlesonly:
24+
25+
intro-to/databases
26+
27+
Storage and backups
28+
===================
29+
30+
* Our :ref:`explanation-storage` section contains more detail about LVM and
31+
iSCSI
32+
* Our :ref:`explanation-multipath` section explains the key concepts and common
33+
configuration setups for Device Mapper Multipathing
34+
* :ref:`introduction-to-backups` discusses various backup strategies to protect
35+
your data
36+
37+
.. toctree::
38+
:hidden:
39+
40+
storage
41+
multipath
42+
intro-to/backups
43+
44+
See also
45+
========
46+
47+
* How-to: :ref:`how-to-data-and-storage`

explanation/high-availability.rst

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
11
.. _explanation-high-availability:
22

3-
High availability
3+
High Availability
44
******************
55

6+
High Availability is a way to ensure minimal downtime if and when system
7+
failures occur by using redundancy, failover and load balancing to keep
8+
services running.
9+
10+
Introduction
11+
============
12+
13+
* :ref:`Introduction to High Availability <introduction-to-high-availability>`
14+
15+
Key concepts
16+
============
17+
618
* :ref:`Pacemaker resource agents <pacemaker-resource-agents>`
719
* :ref:`Pacemaker fence agents <pacemaker-fence-agents>`
820

921
.. toctree::
1022
:hidden:
1123

24+
Introduction to HA <intro-to/high-availability>
1225
Pacemaker resource agents <high-availability/pacemaker-resource-agents>
1326
Pacemaker fence agents <high-availability/pacemaker-fence-agents>
27+
28+
See also
29+
========
30+
31+
* How-to: :ref:`Set up a Distributed Replicated Block Device (DRBD) <install-drbd>`
32+
* Reference: :ref:`reference-high-availability`

explanation/index.rst

+83-43
Original file line numberDiff line numberDiff line change
@@ -8,86 +8,126 @@ understanding of how Ubuntu Server works and how it can be used and configured.
88
They enable you to expand your knowledge, making the operating system easier
99
to use.
1010

11-
Introduction to...
12-
==================
13-
14-
.. include:: introduction-to.rst
15-
:start-line: 4
16-
:end-before: .. toctree::
11+
If you're not sure how or where to get started with a topic, each section has
12+
"introduction to" pages to give you a high-level overview and relevant links
13+
to help you navigate to the guides and other materials of most interest to you.
1714

1815
Security
1916
========
2017

21-
:ref:`Our security section <explanation-security>` includes additional
22-
discussion of concepts and features around authentication, cryptography, and
23-
Virtual Private Networks (VPNs).
18+
:ref:`Our security explanations <explanation-security>` include high-level
19+
overviews of security configuration and good practices, and discussion of key
20+
concepts in the following topics:
21+
22+
* **Authentication**, with introductions to Kerberos and SSSD
23+
* **Cryptography** and cryptographic libraries
24+
* **Virtual Private Networks (VPNs)** with introductions to WireGuard VPN and
25+
its related concepts
26+
27+
.. toctree::
28+
:hidden:
29+
:titlesonly:
2430

25-
For more general introductions to these topics, see:
31+
security.rst
2632

27-
* :ref:`introduction-to-security`
28-
* :ref:`introduction-to-crypto-libraries`
29-
* :ref:`introduction-to-wireguard-vpn`
30-
3133
Networking
3234
==========
3335

34-
.. include:: networking.rst
35-
:start-line: 4
36-
:end-before: .. toctree::
36+
:ref:`Our networking section <explanation-networking>` will give you an
37+
introduction to networking and details on some of the key topics, such as:
38+
39+
* **Network tooling and configuration**
40+
* **Network shares**
41+
42+
.. toctree::
43+
:hidden:
44+
:titlesonly:
45+
46+
networking.rst
3747

3848
Managing software
3949
=================
4050

41-
.. include:: software.rst
42-
:start-line: 4
43-
:end-before: .. toctree::
51+
:ref:`Managing software <explanation-managing-software>` is an integral part of
52+
system maintenance.
53+
54+
.. toctree::
55+
:hidden:
56+
:titlesonly:
57+
58+
software.rst
4459

4560
Storage
4661
=======
4762

48-
.. include:: storage.rst
49-
:start-line: 4
50-
:end-before: .. toctree::
63+
:ref:`In data and storage <explanation-data-and-storage>` we discuss:
64+
65+
* **Managing data**
66+
* **Storage and backups**
67+
68+
.. toctree::
69+
:hidden:
70+
:titlesonly:
71+
72+
data-and-storage.rst
5173

5274
Web services
5375
============
5476

55-
.. include:: web-services.rst
56-
:start-line: 4
57-
:end-before: .. toctree::
77+
Our :ref:`explanation-web-services` section includes details about web servers
78+
and how they work, as well as related topics like Squid proxy servers.
79+
80+
.. toctree::
81+
:hidden:
82+
:titlesonly:
83+
84+
web-services.rst
5885

5986
Virtualisation and containers
6087
=============================
6188

62-
.. include:: virtualisation.rst
63-
:start-line: 4
64-
:end-before: .. toctree::
89+
Our :ref:`Virtualisation and containers <explanation-virtualisation>` section
90+
includes overviews of the available virtualisation and container tooling in
91+
the Ubuntu space, as well as more detail about topics like rock images, Docker
92+
and more!
93+
94+
.. toctree::
95+
:hidden:
96+
:titlesonly:
97+
98+
virtualisation.rst
6599

66100
System tuning
67101
=============
68102

69-
.. include:: performance.rst
70-
:start-after: _end-system-tuning-intro:
71-
:end-before: .. toctree::
103+
:ref:`Our system tuning <explanation-system-tuning>` section provides details
104+
on system performance and optimization, covering concepts like Profile-Guided
105+
Optimization (PGO) and some common tooling.
106+
107+
.. toctree::
108+
:hidden:
109+
:titlesonly:
110+
111+
performance.rst
72112

73113
High Availability
74114
=================
75115

76-
.. include:: high-availability.rst
77-
:start-line: 4
78-
:end-before: .. toctree::
116+
:ref:`High Availability <explanation-high-availability>` is a method for
117+
clustering resources to ensure minimal downtime if a particular component fails.
118+
119+
In this section we provide an introduction to High Availability and explain
120+
some of the key concepts.
79121

80122
.. toctree::
81123
:hidden:
82124
:titlesonly:
83125

84-
introduction-to.rst
85-
security.rst
86-
networking.rst
87-
software.rst
88-
storage.rst
89-
virtualisation.rst
90-
web-services.rst
91-
performance.rst
92126
high-availability.rst
93127

128+
.. toctree::
129+
:hidden:
130+
:titlesonly:
131+
132+
introduction-to.rst
133+

explanation/introduction-to.rst

+1-44
Original file line numberDiff line numberDiff line change
@@ -11,39 +11,9 @@ help you navigate to the guides and other materials of most interest to you.
1111

1212
* :ref:`Introduction to virtualization <introduction-to-virtualization>`
1313

14-
**Networking**
15-
16-
* :ref:`Introduction to networking <introduction-to-networking>`
17-
* :ref:`Introduction to Samba <introduction-to-samba>`
18-
* :ref:`Introduction to Active Directory integration <introduction-to-active-directory-integration>`
19-
* :ref:`Introduction to Device mapper multipathing <introduction-to-multipath>`
20-
21-
22-
**Authentication and access**
23-
24-
* :ref:`Introduction to Kerberos <introduction-to-kerberos>`
25-
* :ref:`Introduction to SSSD <introduction-to-network-user-authentication-with-sssd>`
26-
* :ref:`Introduction to OpenLDAP <introduction-to-openldap>`
27-
28-
29-
**Security**
30-
31-
* :ref:`Introduction to security <introduction-to-security>`
32-
* :ref:`Introduction to cryptographic libraries <introduction-to-crypto-libraries>`
33-
* :ref:`Introduction to WireGuard VPN <introduction-to-wireguard-vpn>`
34-
35-
3614
**Useful services**
3715

3816
* :ref:`Introduction to mail servers <introduction-to-mail-services>`
39-
* :ref:`Introduction to web servers <introduction-to-web-servers>`
40-
* :ref:`Introduction to backups <introduction-to-backups>`
41-
* :ref:`Introduction to databases <introduction-to-databases>`
42-
43-
44-
**High Availability**
45-
46-
* :ref:`Introduction to High Availability <introduction-to-high-availability>`
4717

4818
**eBPF**
4919

@@ -57,20 +27,7 @@ help you navigate to the guides and other materials of most interest to you.
5727
:hidden:
5828

5929
Virtualization <intro-to/virtualisation>
60-
Networking <intro-to/networking>
61-
Samba <intro-to/samba>
62-
Active Directory integration <intro-to/AD-integration>
63-
Device mapper multipathing <intro-to/multipath>
64-
Kerberos <intro-to/kerberos>
65-
SSSD <intro-to/sssd>
66-
OpenLDAP <intro-to/openldap>
67-
Security <intro-to/security>
68-
Cryptographic libraries <intro-to/crypto-libraries>
69-
WireGuard VPN <intro-to/wireguard-vpn>
7030
Mail servers <intro-to/mail-services>
71-
Web servers <intro-to/web-servers>
72-
Backups <intro-to/backups>
73-
Databases <intro-to/databases>
74-
High Availability <intro-to/high-availability>
7531
eBPF <intro-to/ebpf>
7632
Cloud-init <intro-to/cloud-init>
33+

0 commit comments

Comments
 (0)