Commit e5259404 authored by Jon Pugh's avatar Jon Pugh

Updates README.md

Auto commit by GitBook Editor
parent 1cbbd6e6
Aegir Documentation Project
===========================
This project aims to document the Aegir Hosting System. It uses mkdocs to build the site at http://docs.aegirproject.org. To get started contributing to this project, fork it on Github. Then install mkdocs and clone this repo:
# brew install python; # For OSX users
# aptitude install python-pip # For Debian/Ubuntu users
# pip install mkdocs
$ git clone https://github.com/aegir-project/documentation.git aegir-docs
$ cd aegir-docs
$ git remote add sandbox https://github.com/<username>/documentation.git
$ mkdocs serve
Your local aegir-docs site should now be available for browsing: http://127.0.0.1:8000/. When you find a typo, an error, unclear or missing explanations or instructions, hit ctrl-c, to stop the server, and start editing. Find the page you’d like to edit; everything is in the docs/ directory. Make your changes, commit and push them, and start a pull request:
$ git checkout -b fix_typo
$ ls -p docs/
index.md install/ install.md quick-start.md
$ vim docs/quick-start.md # Add/edit/remove whatever you see fit. Be bold!
$ mkdocs build --clean; mkdocs serve # Go check your changes. We’ll wait...
$ git diff # Make sure there aren’t any unintended changes.
diff --git a/docs/quick-start.md b/docs/quick-start.md
index 88f9974..e69de29 100644
...
$ git commit -am”Fixed typo.” # Useful commit message are a good habit.
$ git push sandbox fix_typo
Visit your fork on Github and start a Pull Request. After we accept a pull request or two, we’ll probably invite you to join the project team, and thus grant you commit rights to the main documentation project.
# Aegir Hosting System
Aegir is a powerful hosting system that sits alongside a LAMP or LEMP server to create, deploy and manage Drupal sites.
With Aegir, you can setup a Drupal site in just a few clicks. Aegir creates the web server's site configuration files, the site's database, runs the Drupal installation process and reloads the relevant services, all automatically.
This documentation will help you understand Aegir and how [install it](/install.md), as well as how to [use it](/usage.md) on an ongoing basis. In addition, for advanced users, you'll find a [list of extensions](extend/contrib.md), as well as other mechanisms you can use to [extend or customize its behaviour](extend.md). Finally, for anyone interested in customizing Aegir or contributing bug fixes or new features, there's a section on [developing Aegir](develop.md).
Aegir is Free/Libre Open-source Software, and so is driven by its welcoming and inclusive [community](community.md).
If you need professional support for your Aegir installation, check out the [Service Providers page](/community/services.md).
# Summary
* [Introduction](README.md)
* [Quick Start](docs/quick-start.md)
* [Install](/docs/install.md#installation-guide)
* [Upgrade](docs/install/upgrade.md)
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