-
Notifications
You must be signed in to change notification settings - Fork 1
/
documentation.html
87 lines (70 loc) · 4.95 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="keywords" content="anweddol, The Anweddol project, virtualization, python, open-source">
<meta name="description" content="See the Anweddol project documentation pages.">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="language" content="en">
<meta name="robots" content="index, follow">
<link rel="canonical" href= "https://the-anweddol-project.github.io/documentation.html">
<link rel="stylesheet" href="style.css">
<link rel="icon" href="imgs/icons/icon2.png">
<title>Documentation // The Anweddol project</title>
</head>
<body>
<header>
<section class="logo">
<img src="imgs/logo.png" alt="'Anghofio', the Anweddol project logo">
<h1>The Anweddol Project</h1>
</section>
<nav>
<ul>
<li><a hreflang="en" href="index.html">Home</a></li>
<li><a hreflang="en" href="documentation.html" class="active">Documentation</a></li>
<li><a hreflang="en" href="installation.html">Installation</a></li>
<li><a hreflang="en" href="contribute.html">Contribute</a></li>
<li><a hreflang="en" href="social.html">Social</a></li>
</ul>
</nav>
</header>
<main>
<article class="web-article">
<h2>Documentation</h2>
<p>All of the technical aspects of Anweddol are documented on the corresponding implementations readthedocs pages, and for every field of use.</br></br>On this page you will retrieve all the links and references to the documentation for each implementation, if you have any questions or comments concerning the documentation, open an issue on the affiliated repository or post it on the project <a class="link-anchor" target="_blank" rel="noopener noreferrer" hreflang="en" href="https://anweddol.zulipchat.com/">[Zulip organization]</a>.</p>
</article>
<article class="web-article">
<h2>Note on implementation installation</h2>
<p>When an Anweddol implementation is installed, there is actually 2 distinct elements installed :</p>
<ul>
<li><span class="bold-title">The python package :</span> Contains all the basic features and tools that an Anweddol implementation must have to be functional: it can be used by developers to create their own Anweddol-related software.</li>
<li><span class="bold-title">The built-in CLI software :</span> The ready-to-use CLI based on the current python package. It allows users to benefit directly from the implementation without having to code their own software. Note that it is dependant of the python package itself, which is why it is integrated.</li>
</ul>
</article>
<article class="web-article">
<h2><span class="italic-title">Anweddol-client</span> documentation links</h2>
<section class="link-anchor-button-row">
<a class="link-anchor-button" target="_blank" rel="noopener noreferrer" hreflang="en" href="https://anweddol-client.readthedocs.io/en/latest/usage_guide/index.html">Usage guide</a>
<a class="link-anchor-button" target="_blank" rel="noopener noreferrer" hreflang="en" href="https://anweddol-client.readthedocs.io/en/latest/technical_specifications/index.html">Technical specifications</a>
<a class="link-anchor-button" target="_blank" rel="noopener noreferrer" hreflang="en" href="https://anweddol-client.readthedocs.io/en/latest/developer_section/index.html">Developer section</a>
</section>
</article>
<article class="web-article">
<h2><span class="italic-title">Anweddol-server</span> documentation links</h2>
<section class="link-anchor-button-row">
<a class="link-anchor-button" target="_blank" rel="noopener noreferrer" hreflang="en" href="https://anweddol-server.readthedocs.io/en/latest/administration_guide/index.html">Administration guide</a>
<a class="link-anchor-button" target="_blank" rel="noopener noreferrer" hreflang="en" href="https://anweddol-server.readthedocs.io/en/latest/technical_specifications/index.html">Technical specifications</a>
<a class="link-anchor-button" target="_blank" rel="noopener noreferrer" hreflang="en" href="https://anweddol-server.readthedocs.io/en/latest/developer_section/index.html">Developer section</a>
</section>
</article>
<article class="web-article">
<h2>ISO factory</h2>
<p>The Anweddol ISO factory is a BASH script that creates up-to-date, functional debian images for use by Anweddol servers as container OSes. Although there is no documentation of its own, there are instructions for use in the README file on the dedicated repository:</p>
<a class="link-anchor-button" target="_blank" rel="noopener noreferrer" hreflang="en" href="https://github.com/the-anweddol-project/Anweddol-ISO-factory">ISO Factory repository</a>
</article>
</main>
<footer>
<p>Copyright 2023 The Anweddol project - Website source code <a class="link-anchor" target="_blank" rel="noopener noreferrer" hreflang="en" href="https://github.com/the-anweddol-project/the-anweddol-project.github.io">[here]</a></p>
</footer>
</body>
</html>