Begin making this repository into the official farmOS.org codebase.
This commit is contained in:
Michael Stenta
parent
6ac93d5bf4
commit
009359b5a5
29
README.md
29
README.md
|
|
@ -1,17 +1,28 @@
|
|||
farmOS Documentation Project
|
||||
============================
|
||||
farmOS.org
|
||||
==========
|
||||
|
||||
This project aims to document the farmOS Drupal distribution. It uses mkdocs to build the site at http://docs.farmos.org. To get started contributing to this project, fork it on Github. Then install mkdocs and clone this repo:
|
||||
This repository contains all the code and content used to build
|
||||
[https://farmOS.org](https://farmOS.org).
|
||||
|
||||
It uses [mkdocs](http://www.mkdocs.org) to convert simple markdown files into
|
||||
static HTML files.
|
||||
|
||||
To get started contributing to this project, fork it on Github. Then install
|
||||
mkdocs and clone this repo:
|
||||
|
||||
$ brew install python # For OSX users
|
||||
$ sudo apt-get install python-pip # For Debian/Ubuntu users
|
||||
$ sudo pip install mkdocs
|
||||
$ git clone https://github.com/farmOS/documentation.git farmOS-docs
|
||||
$ cd farmOS-docs
|
||||
$ git remote add sandbox git@github.com:<username>/farmOS-docs.git
|
||||
$ git clone https://github.com/farmOS/farmOS.org.git farmOS.org
|
||||
$ cd farmOS.org
|
||||
$ git remote add sandbox git@github.com:<username>/farmOS.org.git
|
||||
$ mkdocs serve
|
||||
|
||||
Your local farmOS-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:
|
||||
Your local farmOS.org 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 # Create a new branch for your changes.
|
||||
... # Make your changes.
|
||||
|
|
@ -23,4 +34,6 @@ Your local farmOS-docs site should now be available for browsing: http://127.0.0
|
|||
|
||||
Visit your fork on Github and start a Pull Request.
|
||||
|
||||
For more information on writing and managing documentation with mkdocs, read the official mkdocs documentation: [http://www.mkdocs.org](http://www.mkdocs.org)
|
||||
For more information on writing and managing documentation with mkdocs, read the
|
||||
official mkdocs documentation: [http://www.mkdocs.org](http://www.mkdocs.org)
|
||||
|
||||
|
|
|
|||
|
|
@ -3,14 +3,14 @@
|
|||
<head>
|
||||
<meta charset=utf-8>
|
||||
<title>Page not found</title>
|
||||
<link rel=canonical href="http://docs.farmos.org">
|
||||
<meta http-equiv=refresh content="1; url=http://docs.farmos.org">
|
||||
<link rel=canonical href="http://farmos.org">
|
||||
<meta http-equiv=refresh content="1; url=http://farmos.org">
|
||||
</head>
|
||||
<body>
|
||||
<h1>Page not found</h1>
|
||||
<p>
|
||||
You will be redirected automatically to docs.farmOS.org
|
||||
<a href="http://docs.farmos.org">Click here if you are not redirected.</a>
|
||||
You will be redirected automatically to farmOS.org
|
||||
<a href="http://farmos.org">Click here if you are not redirected.</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
docs.farmos.org
|
||||
farmos.org
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ You can also chat with people directly in the [#farmOS IRC channel on Freenode].
|
|||
## Documentation
|
||||
|
||||
If you are interested in helping with documentation, create a new issue in the
|
||||
[Github issue queue]. Or, fork the [documentation repository] on Github, make
|
||||
[Github issue queue]. Or, fork the [farmOS.org repository] on Github, make
|
||||
changes, and create a pull request.
|
||||
|
||||
## Development
|
||||
|
|
@ -29,7 +29,6 @@ we'll get done!
|
|||
|
||||
[issue queues]: /development/issue-queues
|
||||
[#farmOS IRC channel on Freenode]: http://webchat.freenode.net/?channels=#farmOS
|
||||
[http://docs.farmos.org]: http://docs.farmos.org
|
||||
[Github issue queue]: https://github.com/farmOS/documentation/issues
|
||||
[documentation repository]: https://github.com/farmOS/documentation
|
||||
[Github issue queue]: https://github.com/farmOS/farmOS.org/issues
|
||||
[farmOS.org repository]: https://github.com/farmOS/farmOS.org
|
||||
|
||||
|
|
|
|||
|
|
@ -27,10 +27,6 @@ now is laying a strong [groundwork], so that others can more easily join in and
|
|||
* Monthly call: [Google Hangout] (2nd Wed of the month at 1pm Eastern)
|
||||
* IRC: [#farmOS on Freenode]
|
||||
|
||||
## Official website
|
||||
|
||||
[http://farmOS.org]
|
||||
|
||||
[Drupal]: https://drupal.org
|
||||
[modular]: http://en.wikipedia.org/wiki/Modular_programming
|
||||
[extensible]: https://www.drupal.org/download
|
||||
|
|
@ -40,7 +36,6 @@ now is laying a strong [groundwork], so that others can more easily join in and
|
|||
[open source]: http://en.wikipedia.org/wiki/Open_source
|
||||
[groundwork]: /development/architecture
|
||||
[contribute]: /contribute
|
||||
[http://farmOS.org]: http://farmos.org
|
||||
[https://drupal.org/project/farm]: https://drupal.org/project/farm
|
||||
[https://github.com/farmOS]: https://github.com/farmOS
|
||||
[Google Hangout]: https://plus.google.com/hangouts/_/farmier.com/farmos-monthly
|
||||
|
|
|
|||
11
mkdocs.yml
11
mkdocs.yml
|
|
@ -1,9 +1,9 @@
|
|||
site_name: farmOS Documentation
|
||||
site_url: http://docs.farmos.org
|
||||
repo_url: https://github.com/farmOS/documentation
|
||||
site_name: farmOS.org
|
||||
site_url: http://farmos.org
|
||||
repo_url: https://github.com/farmOS
|
||||
site_favicon: favicon.ico
|
||||
copyright: <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">farmOS Documentation</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||||
google_analytics: ['UA-56974603-2', 'docs.farmos.org']
|
||||
copyright: <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">farmOS.org</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||||
google_analytics: ['UA-56974603-1', 'farmos.org']
|
||||
pages:
|
||||
- Home: index.md
|
||||
- User Guide:
|
||||
|
|
@ -22,3 +22,4 @@ pages:
|
|||
- Best Practice: development/best-practice.md
|
||||
- Contribute: contribute.md
|
||||
theme: yeti
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue