mirror of
https://github.com/mediacms-io/mediacms.git
synced 2025-11-20 21:46:04 -05:00
documentation improvements (#261)
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
## Configuration
|
||||
|
||||
A number of options are available on `cms/settings.py`.
|
||||
Several options are available on `cms/settings.py`, most of the things that are allowed or should be disallowed are described there.
|
||||
|
||||
It is advisable to override any of them by adding it to `local_settings.py` .
|
||||
|
||||
|
||||
@@ -1,13 +1,12 @@
|
||||
# Administrators documentation
|
||||
|
||||
## Table of contents
|
||||
- [Uploading media](#uploading-media)
|
||||
- [Manage pages](#manage-pages)
|
||||
- [Django admin dashboard](#django-admin-dashboard)
|
||||
- [On portal workflow](#on-portal-workflow)
|
||||
- [On user roles](#on-user-roles)
|
||||
- [Adding languages for Captions and subtitles](#adding-languages-for-captions-and-subtitles)
|
||||
- [Add/delete categories and tags](#add-delete-categories-and-tags)
|
||||
- [Add/delete categories and tags](#adddelete-categories-and-tags)
|
||||
- [Video transcoding](#video-transcoding)
|
||||
|
||||
|
||||
|
||||
@@ -3,14 +3,20 @@
|
||||
## Table of contents
|
||||
- [System architecture](#system-architecture)
|
||||
- [API documentation](#api-documentation)
|
||||
- [How to contribute](#how-to-contribute)
|
||||
- [Working with Docker tips](#working-with-docker-tips)
|
||||
- [How video is transcoded](#how-video-is-transcoded)
|
||||
|
||||
## How to contribute
|
||||
Before you send a PR, make sure your code is properly formatted. For that, use `pre-commit install` to install a pre-commit hook and run `pre-commit run --all` and fix everything before you commit. This pre-commit will check for your code lint everytime you commit a code.
|
||||
|
||||
Checkout the [Code of conduct page](../CODE_OF_CONDUCT.md) if you want to contribute to this repository
|
||||
|
||||
|
||||
## System architecture
|
||||
|
||||
## API documentation
|
||||
API is documented using Swagger - checkout ot http://your_installation/swagger
|
||||
API is documented using Swagger - checkout ot http://your_installation/swagger - example https://demo.mediacms.io/swagger/
|
||||
This page allows you to login to perform authenticated actions - it will also use your session if logged in.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user