From c27e3caff641baa3b6d6319349bb245548d71d98 Mon Sep 17 00:00:00 2001 From: Markos Gogoulos Date: Sun, 1 Aug 2021 19:47:35 +0300 Subject: [PATCH] documentation improvements (#261) --- README.md | 8 +------- docs/Configuration.md | 2 +- docs/admins_docs.md | 3 +-- docs/developers_docs.md | 8 +++++++- 4 files changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1226a63..a39a7a2 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ There are two ways to run MediaCMS, through Docker Compose and through installin ## Configuration -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 cms/local_settings.py. All configuration options will be documented gradually on the [Configuration](docs/Configuration.md) page. +Visit [Configuration](docs/Configuration.md) page. ## Documentation @@ -128,12 +128,6 @@ If you like the project, here's a few things you can do - Star the project - Add functionality, work on a PR, fix an issue! -## Developers info - -- API documentation through Swagger is available under /swagger URL of your installation -example https://demo.mediacms.io/swagger/ -- We're working on proper documentation for users, managers and developers, until then checkout what's available on the docs/ folder of this repository -- 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 ## Contact info@mediacms.io \ No newline at end of file diff --git a/docs/Configuration.md b/docs/Configuration.md index 75b3a03..158b634 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -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` . diff --git a/docs/admins_docs.md b/docs/admins_docs.md index 4fd45ce..f14e139 100644 --- a/docs/admins_docs.md +++ b/docs/admins_docs.md @@ -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) diff --git a/docs/developers_docs.md b/docs/developers_docs.md index f4fc269..9d619fd 100644 --- a/docs/developers_docs.md +++ b/docs/developers_docs.md @@ -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.