Make examples copy/paste friendly

This commit is contained in:
Lucas Bickel 2017-03-04 15:30:05 +01:00
parent 8cc262ae11
commit fba5ce1ce5
3 changed files with 22 additions and 22 deletions

View File

@ -3,26 +3,26 @@ Documentation
The LibreTime documentation site is generated with [mkdocs](http://www.mkdocs.org/). To get started contributing to this project, fork it on Github. Then install mkdocs and clone this repo locally: The LibreTime documentation site is generated with [mkdocs](http://www.mkdocs.org/). To get started contributing to this project, fork it on Github. Then install mkdocs and clone this repo locally:
:::console :::bash
$ sudo brew install python # For OSX users sudo brew install python # For OSX users
$ sudo aptitude install python-pip # For Debian/Ubuntu users sudo aptitude install python-pip # For Debian/Ubuntu users
$ sudo pip install mkdocs sudo pip install mkdocs
$ git clone https://github.com/libretime/libretime git clone https://github.com/libretime/libretime
$ cd libretime cd libretime
$ git remote add sandbox https://github.com/<username>/libretime # URL for your fork git remote add sandbox https://github.com/<username>/libretime # URL for your fork
$ mkdocs build --clean mkdocs build --clean
$ mkdocs serve mkdocs serve
Your local LibreTime docs site should now be available for browsing: [http://localhost:8888/](http://localhost:8888/). Your local LibreTime docs site should now be available for browsing: [http://localhost:8888/](http://localhost:8888/).
When you find a typo, an error, unclear or missing explanations or instructions, open a new terminal and start editing. Your changes should be reflected automatically on the local server. Find the page youd like to edit; everything is in the docs/ directory. Make your changes, commit and push them, and start a pull request: When you find a typo, an error, unclear or missing explanations or instructions, open a new terminal and start editing. Your changes should be reflected automatically on the local server. Find the page youd like to edit; everything is in the docs/ directory. Make your changes, commit and push them, and start a pull request:
:::console :::bash
$ git checkout -b fix_typo git checkout -b fix_typo
$ vi docs/index.md # Add/edit/remove whatever you see fit. Be bold! vi docs/index.md # Add/edit/remove whatever you see fit. Be bold!
$ mkdocs build --clean; mkdocs serve # Go check your changes. Well wait... mkdocs build --clean; mkdocs serve # Go check your changes. Well wait...
$ git diff # Make sure there arent any unintended changes. git diff # Make sure there arent any unintended changes.
$ git commit -am”Fixed typo.” # Useful commit message are a good habit. git commit -am”Fixed typo.” # Useful commit message are a good habit.
$ git push sandbox fix_typo git push sandbox fix_typo
Visit your fork on Github and start a PR. Visit your fork on Github and start a PR.

View File

@ -17,9 +17,9 @@ Getting Started
The easiest way to check out LibreTime for yourself is to run a local instance in a virtual machine. Assuming you already have Git, Vagrant and Virtualbox installed, just run: The easiest way to check out LibreTime for yourself is to run a local instance in a virtual machine. Assuming you already have Git, Vagrant and Virtualbox installed, just run:
:::console :::bash
$ git clone https://github.com/libretime/libretime.git git clone https://github.com/libretime/libretime.git
$ cd libretime cd libretime
$ vagrant up vagrant up
Of course, this setup isn't appropriate for production use. For that, check out our [installation instructions](install.md). Of course, this setup isn't appropriate for production use. For that, check out our [installation instructions](install.md).

View File

@ -3,7 +3,7 @@ Installing LibreTime
LibreTime should generally be installed on a dedicated host. By default, its installer will install and configure all its dependencies. At the moment, the installer works best on Ubuntu Trusty. LibreTime should generally be installed on a dedicated host. By default, its installer will install and configure all its dependencies. At the moment, the installer works best on Ubuntu Trusty.
:::console :::bash
$ ./install ./install
Plans are in the works for ```.deb``` and ```.rpm``` packages, as well as Docker and AWS images. Plans are in the works for ```.deb``` and ```.rpm``` packages, as well as Docker and AWS images.