Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cozy/cozy.github.io
Official documentation for Cozy.
https://github.com/cozy/cozy.github.io
Last synced: 3 months ago
JSON representation
Official documentation for Cozy.
- Host: GitHub
- URL: https://github.com/cozy/cozy.github.io
- Owner: cozy
- License: agpl-3.0
- Created: 2017-06-06T13:33:40.000Z (over 7 years ago)
- Default Branch: dev
- Last Pushed: 2024-04-13T00:57:47.000Z (7 months ago)
- Last Synced: 2024-04-13T20:49:52.682Z (7 months ago)
- Language: Python
- Homepage: https://docs.cozy.io/en/
- Size: 148 MB
- Stars: 88
- Watchers: 13
- Forks: 42
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cozy Documentation
- [Edit this documentation](#edit-this-documentation)
- [External documentations](#external-documentations)
- [When are the docs deployed ?](#when-are-the-docs-deployed-)
- [Testing the statically built site](#testing-the-statically-built-site)
Learn how to [use Cozy](https://docs.cozy.io/en/use), [host your own server](https://docs.cozy.io/en/tutorials/selfhosting/) and [develop applications](https://docs.cozy.io/en/tutorials/app/).
## Edit this documentation
This documentation is built with [MkDocs](http://www.mkdocs.org).
All sources are in the `dev` branch and the `master` branch contains the "live" built site. The CI builds the site from the `dev` branch and automatically publish the built result in the `master` branch.
/!\ PLEASE DO NOT DIRECTLY EDIT THE `master` BRANCH
To edit the documentation, just edit the files inside `src` on the `dev` branch.
If you want to see your updates, install mkdocs:
> In most linux distribution, it will install binary in ~/local/bin/, add it to your path.
Fetch external documentation and add it to mkdocs.yml (do not commit changes done in `mkdocs.yml`) :
```bash
# Activate a virtualenv if you want (recommended)
pip install -r requirements.txt
./build.sh
```
> Expected python version is 3
Run MkDocs:
```shell
mkdocs serve
```
And point your favorite browser to `http://127.0.0.1:8000/`
## External documentations
External documentations are listed in the [OUTSIDE_DOCS](./OUTSIDE_DOCS) file. They are consolidated in this documentation during build.
This lets developers edit their documentation in their repository while the single site makes it convenient
to search for information only in one location.
Each repository maintains its own [table of contents](https://github.com/cozy/cozy-doctypes/blob/master/toc.yml),
which controls what is shown under the References menu.
See [./build.sh](./build.sh), and [./generate_config.py](./generate_config.py) scripts for more information.
The edit links displayed in the header of each article are modified via Javascript to handle outside repositories (mkdocs does not support
this natively).
## When are the docs deployed ?
The documentation build is triggerd automatically and built by Travis
- when a commit is pushed on the `dev` branch
- every day (since we cannot detect changes in external documentations)
After the build, it is available on .
You can trigger a manual build on > `More options` > `Trigger build`.
## Testing the statically built site
To test the whole site:
```shell
./build.sh
cd site/
python -m SimpleHTTPServer
```