Commit 90233c19 authored by MikeyMJCO's avatar MikeyMJCO
Browse files

Update README.md

parent 6c3006fd
......@@ -8,42 +8,9 @@ You may also wish to:
- [*Contribute* to documentation content](https://docs.civicrm.org/dev/en/master/documentation/)
## Documentation books
CiviCRM documentation is organised into various *books*. The content for a book is written in [markdown](https://docs.civicrm.org/dev/en/master/markdownrules/) and stored in a git repository (for example https://github.com/civicrm/civicrm-user-guide ). If a book is translated into different languages, then a separate repository is used for each language. If required, different *versions* of a book can be made by creating different *branches* in a repository. See *Defining books* below for more information.
## Defining a new book
Books are defined with a Yaml configuration file. To define a new book, create a `.yml` file and add it to the `app/config/books/` directory of this repository.
The config file defines the name of the book, the repository that contains the source code, and the **languages** that the book is available in, with a repository for each language. For each language, the configuration file defines:
* which **edition** of the book should be considered **stable**
* where to find the **latest** edits to the book
* a history of book **editions** of the book (these will be publicly listed at https://docs.civicrm.org/).
If you would like to be notified by email whenever an update to a book is published, you can add your email to the notify list.
**Example book definition:**
```yml
name: User guide
description: Aimed at day to day users of CiviCRM.
langs:
en:
repo: 'https://github.com/michaelmcandrew/civicrm-user-guide'
latest: master
stable: 4.7
history:
- 4.6
- 4.5
- 4.4
notify:
michael@civicrm.org # will be notified when documentation is published (as well as any emails mentioned in commits)
ca:
repo: 'https://github.com/babu-cat/civicrm-user-guide-ca'
latest: master
# stable: master (will not be published)
```
## Defining new books
This information/content has moved to a new repository. Click here to see the [docs-books repository](https://lab.civicrm.org/documentation/docs-books).
## Publishing updates to a book
......
Supports Markdown
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