First pass at converting Anaconda docs to asciidoc

This commit is contained in:
Jared Smith 2018-02-26 10:14:58 -05:00
parent 08849e1056
commit 70f1dcd0cc
5 changed files with 195 additions and 3 deletions

View file

@ -52,8 +52,13 @@ Topics:
File: grub2
- Name: (CHECK) Spotify
File: spotify
- Name: (FIX ME!) Anaconda
- Name: (IN PROGRESS) Anaconda
Dir: anaconda
Topics:
- Name: Anaconda
File: anaconda
- Name: Anaconda based Distributions
File: anaconda_distros
- Name: (FIX ME!) AutoUpdates
File: autoupdates
- Name: (FIX ME!) Building a custom kernel

View file

@ -0,0 +1,167 @@
= Anaconda
[caption="Entering Anaconda, Montana. A city probably named after this installation program. David Cantrell took this picture in 2011. His grey VW Jetta is parked in the background."]
image::DSC_3217.JPG[Anaconda,400]
Anaconda is the installation program used by Fedora, Red Hat Enterprise Linux and link:anaconda_distros.html[ some other distributions].
During installation, a target computer's hardware is identified and configured, and the appropriate file systems for the system's architecture are created.
Finally, Anaconda allows the user to install the operating system software on the target computer.
Anaconda can also upgrade existing installations of earlier versions of the same distribution.
After the installation is complete, you can reboot into your installed system and continue doing customization using https://fedoraproject.org/wiki/InitialSetup[initial setup].
Anaconda is a fairly sophisticated installer.
It supports installation from local and remote sources such as CDs and DVDs, images stored on a hard drive, NFS, HTTP, and FTP.
Installation can be scripted with link:Anaconda/Kickstart[ kickstart] to provide a fully unattended installation that can be duplicated on scores of machines.
It can also be run over VNC on headless machines.
A variety of advanced storage devices including LVM, RAID, iSCSI, and multipath are supported from the partitioning program.
Anaconda provides advanced debugging features such as remote logging, access to the python interactive debugger, and remote saving of exception dumps.
[id="users"]
== Users
If you are a user having problems with Anaconda, please use the user support forum for your distribution such as http://forums.fedoraforum.org/forumdisplay.php?f=6[Fedora Forum] or https://admin.fedoraproject.org/mailman/listinfo/users[fedora-users].
From time to time, we may distribute updates for Anaconda to fix problems in Fedora releases.
The link:Anaconda/Updates[ updates] wiki page explains how to use these updates images.
Need to see what's changed from release to release?
See our link:Anaconda/Changes[migration guide] which summarizes changes for users, rebuilders, and contributors.
[id="advanced-users"]
== Advanced Users
If you are an advanced user of Anaconda, you should check out https://anaconda-installer.readthedocs.io/en/latest/boot-options.html[our reference to Anaconda command line options],https://anaconda-installer.readthedocs.io/en/latest/kickstart.html[our kickstart file format documentation] and link:Anaconda/Logging[ our reference to logging capabilities of Anaconda].
There is a mailing list devoted to the use of kickstart.
You can find the list signup and archive information at http://www.redhat.com/mailman/listinfo/kickstart-list[kickstart list].
This is the best place to share tips and tricks about kickstart.
[id="distribution-builders"]
== Distribution Builders
For information on how to customize Anaconda and trees created with it, please see link:Anaconda/ProductImage[product.img], link:Anaconda/BuildDocProject[BuildDocProject] and link:Anaconda/Customization[Customization].
[id="mailing-lists"]
== Mailing Lists
There are two mailing lists for Anaconda.
The first is the development mailing list. This list is used to discuss development issues, submit patches, and other activities related to extending Anaconda.
The sign up for the development list is located at https://listman.redhat.com/mailman/listinfo/anaconda-devel-list[anaconda development list site].
Past discussions can be found in the https://www.redhat.com/archives/anaconda-devel-list[anaconda development archives].
The second list is a user oriented list on how to create kickstart files.
The kickstart list is the place to discuss automated installation issues.
The sign up for the kickstart list is located at https://www.redhat.com/mailman/listinfo/kickstart-list[anaconda kickstart list site].
Past discussions can be found in the https://www.redhat.com/archives/kickstart-list[anaconda kickstart archives].
Patch review used to take place on a mailing list dedicated to submitting and reviewing patches.
Patch review now takes place on https://github.com/rhinstaller/anaconda/pulls[GitHub] via pull requests.
Past discussions of patches can be found in the https://lists.fedorahosted.org/pipermail/anaconda-patches/[anaconda-patches archives], which is the main purpose this mailing list now serves.
[id="irc"]
== IRC
There is also an IRC channel on http://freenode.net.
This resource is for discussion of Anaconda development, not for distribution customization questions.
[id="how-to-contribute"]
== How to Contribute
For how to contribute to Anaconda and related projects, see the https://fedoraproject.org/wiki/Anaconda/Contribute[Contributing to Anaconda and related projects] documentation.
Please note that useful contributions are not limited to submitting patches for source code.
You can also help with https://anaconda-installer.readthedocs.io/en/latest/testing.html[testing], reporting bugs, improving translations or extending the Anaconda documentation.
[id="developers-guide"]
== Developers' Guide
Anaconda is now almost entirely written in Python 3.
The graphical front end uses GTK+ 3 via gobject-introspection, and as much of the interface as possible is written using the glade interface builder.
The earliest parts of Anaconda are in shell for integration with dracut, and there's still a little bit of C thrown in for interfacing with certain libraries.
Here are some documents if you are planning on working on Anaconda.
More are in the works:
* Anaconda/Devel/Translation
* If you want to work on Anaconda, you should start with the link:Anaconda/SourceOverview[Source Overview], which contains a high level discussion of the source files and what they do.
Then look at the https://anaconda-installer.readthedocs.io/en/latest/[online documentation] for information on how to test, debug, and develop anaconda.
Familiarize yourself with the tools that Anaconda uses.
Check out the following external reference documents:
* https://developer.gnome.org/gtk3/stable/[GTK+ reference]
* https://docs.python.org/2/tutorial/[Python tutorial]
* https://docs.python.org/2/py-modindex.html[Python module reference]
[id="getting-the-source"]
== Getting the Source
The primary methods of distributing the Anaconda source are source RPMs in the http://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/source/SRPMS/[Fedora development tree] and git.
To access the current source code in in non-rpm format, you'll need to install git.
----
$ dnf install git
----
Note that several related packages will be installed as well.
After the git source code management tool has been installed, then you use anonymous git access to the Anaconda repository.
----
$ git clone https://github.com/rhinstaller/anaconda.git
----
The output may look similar to the following:
----
Initialized empty Git repository in /home/drkludge/anacondatest/anaconda/.git/
remote: Generating pack...
remote: Counting objects: 10861
remote: Done counting 91222 objects.
remote: Deltifying 91222 objects...
remote:  100% (91222/91222) done
Indexing 91222 objects...
100% (91222/91222) done
remote: Total 91222 (delta 68785), reused 90187 (delta 68059)
Resolving 68785 deltas...
100% (68785/68785) done
Checking 543 files out...
100% (543/543) done
----
If you have committer access to Anaconda, then you will want to use the git+ssh access url.
----
$ git clone git+ssh://git@github.com/rhinstaller/anaconda.git
----
Once you've committed changes locally, you can push them with
----
$ git push
----
If you would just like to browse the Anaconda git repository via the web, then please use the following https://github.com/rhinstaller/anaconda.git[Anaconda git URLs].
Anaconda has an https://github.com/rhinstaller/kickstart-tests[extensive suite of tests] that is still growing.
If you contribute new functionality, it's good practice to include some tests along with that.
We have a https://anaconda-installer.readthedocs.io/en/latest/testing.html[document that outlines the test suite infratructure and describes how to run tests].
To contribute you should read our https://anaconda-installer.readthedocs.io/en/latest/contributing.html[guidelines for contributing].
[id="reporting-problems"]
== Reporting Problems
If you are having difficulty installing, please file the problem report with your distribution vendor.
Before filing a bug, please read up on link:How_to_debug_installation_problems[How to debug installation problems], which will tell you how to fill out useful bug reports that will help us quickly solve your problem.
Also try searching bugzilla for other reports about your problem, as some bugs are often filed by several people.
link:Anaconda/AnacondaBugWorkflow[AnacondaBugWorkflow] is a guideline to how Fedora Anaconda bugs pass through bugzilla, and what all the various statuses really mean. This is *only* for Fedora.
[[design]]
Design
~~~~~~
* link:Anaconda/UX_Redesign[ Anaconda UX Redesign]
* link:How_to_Create_an_Anaconda_Banner[ How to Create an Anaconda Banner]

View file

@ -0,0 +1,20 @@
= Anaconda based Distributions
There are a number of distributions which currently use Anaconda. This is a list of the ones which we are aware of.
* Fedora
* Red Hat Enterprise Linux
* rpath Linux
* Progeny Componentized Linux, based on Debian (defunct)
* Vida linux, Gentoo variant using Anaconda
* Foresight Linux, originally derived from rpath Linux
* Sabayon Linux Installer
* Aurox
* Asianux
* Blag GNU/Linux
* ASPLinux
* Fedora derivatives
* FrameOS Linux
* Scientific Linux
There are likely many more distributions using Anaconda. Feel free to contact the authors to add to this list.

View file

Before

Width:  |  Height:  |  Size: 362 KiB

After

Width:  |  Height:  |  Size: 362 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 456 KiB