Skip to content

Adélie Documentation
Adélie Documentation
Verified Commit de0f71a3 authored by A. Wilcox's avatar A. Wilcox
Browse files
Options

Initial commit

parents
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 231 additions and 0 deletions
.gitignore 0 → 100644
View file @ de0f71a3
# Processed source
*.html
CONTRIBUTING.rst 0 → 100644
View file @ de0f71a3
===================================================
Contribution Guide for Adélie Linux Documentation
===================================================
:Author:
* **A. Wilcox**, documentation writer
:Copyright:
© 2015-2017 Adélie Linux. CC BY-NC-SA open source licence.
Introduction
============
This distribution contains the documentation set for Adélie Linux.
Contributing Changes
====================
This section describes the usual flows of contribution to this repository.
GitLab Pull Requests
````````````````````
#. If you do not already have a GitLab account, you must create one.
#. Create a *fork* of the packages repository. For more information, consult
the GitLab online documentation.
#. Clone your forked repository to your computer.
#. Make your changes.
#. Test your changes to ensure they are correct.
#. Add (or remove) changed files using ``git add`` and ``git rm``.
#. Commit your changes to the tree using the command ``git commit`` and
``git push``.
#. Visit your forked repository in a Web browser.
#. Choose the *Create Pull Request* button.
#. Review your changes to ensure they are correct, and then submit the form.
Mailing List
````````````
#. Clone the packages repository to your computer.
#. Make your changes.
#. Test your changes to ensure they are correct.
#. Add (or remove) changed files using ``git add`` and ``git rm``.
#. Commit your changes to the tree using the command ``git commit``.
#. Use the command ``git format-patch HEAD^`` to create a patch file for your
commit.
.. note:: If you have made multiple commits to the tree, you will need to
add an additional ^ for each commit you have made. For example,
if you have made three commits, you will use the command
``git format-patch HEAD^^^``.
#. Email the resulting patch to the documentation mailing list.
LICENSE 0 → 100644
View file @ de0f71a3
This diff is collapsed.
README.rst 0 → 100644
View file @ de0f71a3
=======================================
README for Adélie Linux Documentation
=======================================
:Authors:
* **A. Wilcox**, primary writer
* **Elizabeth Myers**, translator
:Status:
Draft
:Copyright:
© 2015-2017 Adélie Linux. CC BY-NC-SA open source license.
Introduction
============
This distribution contains the documentation set for Adélie Linux.
License
```````
This documentation is licensed under a
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
You should have received a copy of the license along with this
work. If not, see <http://creativecommons.org/licenses/by-nc-sa/4.0/>.
Changes
```````
Any changes to this repository must be reviewed before being pushed to the
master branch.
install/1_begin.xml 0 → 100644
View file @ de0f71a3
<?xml version="1.0" encoding="utf-8"?>
<chapter label="1" id="begin">
<title>Before You Begin</title>
<para>Welcome to the Adélie Linux 1.0 Installation Guide. This guide will describe the process you will use to install Adélie Linux on to a computer.</para>
<para>If you are installing Adélie Linux to your main computer, you may use another device - such as a mobile phone or a friend's laptop, if available - to follow along with this guide.
Additionally, most portions of this guide are available on the installation CD for viewing during installation. Just choose "Help" from any page in the Horizon Installation Wizard.</para>
<section>
<title>Preparing for the installation</title>
<para>Please back up all of your data before beginning installation.
While every effort is made to ensure that the Adélie Linux installation routines are safe and error-free, we cannot guarantee that your data will be preserved once you start the installation.
If you intend on dual-booting your computer with another operating system, such as Mac OS X or Windows, ensure there is adequate disk space available to install Adélie Linux.
You will need up to 1 GB for a standard desktop installation, or at least 300 MB for a server installation.</para>
<para>To install Adélie Linux to a desktop or portable computer, you will need a display capable of at least 800x600 pixel resolution.
Most common desktop displays display in at least this resolution. HiDPI (or "Retina") displays are supported only on the KDE Desktop installation media.
Please note that the server installation media may render incorrectly, or even not at all, when using HiDPI displays.
You may install server packages using the desktop installation media if you need to use a HiDPI display during server installation.</para>
<para>To install Adélie Linux to a server, you will need either a display capable of at least 80x25 text console (720x480), or a supported serial line.
If you are installing via serial line, be sure you know your server's serial line settings.
Most servers default to either 9600 or 57200 baud; Adélie Linux does not reconfigure the serial line, so you will need to know your firmware's default settings.</para>
<para>If you plan on connecting to the Internet directly from your Adélie Linux computer without using a router (not common),
ensure you have your Internet access credentials (typically a username and password) available before starting installation.
Adélie Linux supports connecting to most ADSL and dial-up Internet providers using PPP; and cable, T1, and fibre providers using Ethernet.
If you use a static IP address (not common), make sure you have your IP address, subnet, and default gateway and nameserver settings before starting installation.</para>
<para>If your computer came with recovery media, we recommend that you have it available in the very unlikely event you have an issue with Adélie Linux, or your hardware has an incompatibility.
This way, you will be able to quickly restore your computer to normal operation.</para>
</section>
<section>
<title>Creating the installation media</title>
<para>You will need either:</para>
<itemizedlist>
<listitem><para>a <hardware>CD drive</hardware> capable of burning a CD, and a blank CD; or</para></listitem>
<listitem><para>a blank <hardware>USB flash drive</hardware>.</para></listitem>
</itemizedlist>
<para>Download the installation media file from your local Adélie Linux mirror. Follow the instructions on the mirror's site to choose the media file appropriate for your computer.
Then, follow the steps below for your current operating environment.</para>
<section>
<title>Using Windows</title>
<para>TODO</para>
</section>
<section>
<title>Using Mac OS X</title>
<para>TODO</para>
</section>
<section>
<title>Using Linux or BSD</title>
<para>TODO</para>
</section>
</section>
</chapter>
install/2_req.xml 0 → 100644
View file @ de0f71a3
<?xml version="1.0" encoding="utf-8"?>
<chapter label="2" id="requirements">
<title>System Requirements</title>
<para>Ensure that your computer meets the following requirements before installing Adélie Linux.
On Windows, you may run the <command>msinfo32</command> program to determine your computer's specifications.
On a Macintosh, choose <guimenuitem>About This Mac</guimenuitem> from the <guimenu>Apple</guimenu> menu, and then choose <guibutton>System Report</guibutton> or <guibutton>More Info</guibutton>.
</para>
<section>
<title>Intel x86 (32-bit)</title>
<para>You will need at least a 486, Pentium, or Celeron CPU. Speeds of at least 500 MHz are highly recommended for running desktop applications, but speeds as low as 50 MHz may be usable in server mode.</para>
<para>At least 256 MB RAM is required to install the desktop version of Adélie Linux, and at least 512 MB RAM is highly recommended if you plan to run larger applications like Firefox and Thunderbird.
At least 40 MB RAM is required to install the server version of Adélie Linux.
<warning><para>Using less than 40 MB RAM may cause lock ups or crashes during package installation.</para></warning>
</para>
<para>At least 3 GB of disk space is required for a full desktop installation of Adélie Linux.
The base server installation of Adélie Linux requires about 300 MB of disk space, not counting additional packages and your data.
It is recommended that you have at least 1 GB of disk space for most server roles.</para>
</section>
<section>
<title>Intel x86_64 (64-bit)</title>
<para>All Intel CPUs that have 64-bit extensions are supported by the Adélie Linux kernel and software distribution.</para>
<para>At least 256 MB RAM is required to install the desktop version of Adélie Linux, and at least 512 MB RAM is highly recommended if you plan to run larger applications like Firefox and Thunderbird.
At least 48 MB RAM is required to install the server version of Adélie Linux.
<warning><para>Using less than 48 MB RAM may cause lock ups or crashes during package installation.</para></warning>
</para>
<para>At least 3 GB of disk space is required for a full desktop installation of Adélie Linux.
The base server installation of Adélie Linux requires about 270 MB of disk space, not counting additional packages and your data.
It is recommended that you have at least 1 GB of disk space for most server roles.</para>
</section>
<section>
<title>PowerPC (32-bit)</title>
<para>You will need at least a G3 CPU. The 603 series is not supported by this version of Adélie Linux.
Speeds of at least 600 MHz are highly recommended for running desktop applications, but all G3 and G4 CPUs are supported.</para>
<para>At least 3 GB of disk space is required for a full desktop installation of Adélie Linux.
The base server installation of Adélie Linux requires about 200 MB of disk space, not counting additional packages and your data.
It is recommended that you have at least 1 GB of disk space for most server roles.</para>
</section>
<section>
<title>PowerPC (64-bit)</title>
<para>You will need a POWER4+ or 970fx, or later generation CPU. You cannot use Adélie Linux on a POWER3 or earlier CPU.</para>
<para>At least 3 GB of disk space is required for a full desktop installation of Adélie Linux.
The base server installation of Adélie Linux requires about 200 MB of disk space, not counting additional packages and your data.
It is recommended that you have at least 1 GB of disk space for most server roles.</para>
</section>
</chapter>
install/installguide.xml 0 → 100644
View file @ de0f71a3
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY chap1 SYSTEM "1_begin.xml">
<!ENTITY chap2 SYSTEM "2_req.xml">
]>
<book>
<bookinfo>
<title>Adélie Linux 1.0 Installation Guide</title>
<author>
<personname><firstname>A.</firstname><surname>Wilcox</surname></personname>
</author>
<copyright><year>2015</year><year>2017</year><holder>Adélie Linux</holder></copyright>
</bookinfo>
<preface>
<title>Preface</title>
<para>This Installation Guide is the full, official guide to installing Adélie Linux 1.0 on a supported computer, including special architecture-specific notes and a bootstrap installation from another distribution. It was initially drafted with a section outline in 2015, before the distribution itself was even created. It is hoped by the author that you find this guide easy to understand and read.</para>
<para>Many contributed to the final version of this guide. This includes <personname><othername>[[sroracle]]</othername></personname> and <personname><othername>smauel</othername></personname> on the Adélie IRC channel, whom tested the instructions on their machines and reported omissions and corrections. <!-- more.. --></para>
<para>Please feel free to contact me or the Adélie Linux community if you have any suggestions on how to make this guide better. We'd love to hear from you, and we hope you enjoy using our distribution.</para>
<para>– A. Wilcox, 2017</para>
</preface>
&chap1;
&chap2;
<!-- <xi:include href="3_install.xml" />
<xi:include href="4_options.xml" />
<xi:include href="5_commit.xml" />
<xi:include href="6_notes.xml" />
<xi:include href="a_arch.xml" />
<xi:include href="b_help.xml" />
<xi:include href="c_advanced.xml" /> -->
</book>
Markdown is supported
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