Small doc fixes

This commit is contained in:
buddh4 2019-01-30 14:00:35 +01:00
parent 20c33db8d5
commit 46ccca82ad
3 changed files with 18 additions and 17 deletions

View File

@ -321,7 +321,7 @@ $model->content->canArchive();
```
## ContentContainer and ContentContainerActiveRecords
## ContentContainer
[[humhub\modules\content\models\ContentContainer|ContentContainers]] in HumHub are used to assign `Content` entries to a specific
container like a `User Account` or `Space`. Similar to `Content` and `ContentActiveRecords`, `ContentContainer` entries can be seen as an abstraction

View File

@ -1,29 +1,29 @@
Development Environment
=======================
This guide shows some recommended settings of your development environment.
This guide describes some recommended settings of your development environment.
# Quick Notes
## Quick Notes
- Make sure you are using a [Git/Composer HumHub installation](git-installation.md)
- Make sure the `debug` mode is enabled (default), see [Enable Production Mode](../admin/security.md#enable-production-mode)
- Disable caching under `Administration -> Settings -> Advanced -> Caching -> None`
- Use file based mailing `Administration -> Settings -> Advanced -> E-Mail`
Since HumHub v1.3 makes heavy use of [Queues](../admin/asynchronous-tasks.md) you should configure the [Instant or Sync Queue]([Queues](../admin/asynchronous-tasks.md#sync-and-instant-queue))
queue in your development environment. Otherwise you'll have to execute the `queue/run` command manually in order to test `Notifications` or other queued jobs.
> Info: Since HumHub v1.3 makes heavy use of
[Queues](../admin/asynchronous-tasks.md) you should configure the [Instant or Sync Queue](../admin/asynchronous-tasks.md#sync-and-instant-queue)
in your development environment. Otherwise you'll have to execute the `queue/run` command manually in order to test `Notifications` and other queued tasks.
# Git/Composer Installation
## Git/Composer Installation
The following guide describes a git based installation of the HumHub platform. Please note that this is only recommended for
developers and testers and should not be used in production environments.
For production environments, please follow the [Installation Guide for Administrators](../admin/installation.md).
# Database Setup
### Database Setup
Please follow the [Database Setup Section](../admin/installation.md#database-setup) of the administration installation guide.
# Get HumHub
### Get HumHub
- Install [git](https://git-scm.com/)
- Clone the git repository:
@ -46,7 +46,7 @@ composer install
> Note: Since HumHub 1.3 you have to build the production assets manually. The production assets are used for example
in acceptance tests. Please see the [Build Assets Section](build.md#build-assets) for more information.
# External Modules Directory
## External Modules Directory
Custom modules can also be located outside of the default HumHub `modules` directory by
adding a path to the `moduleAutoloadPaths` array parameter in your `protected/config/common.php` configuration. This separation can
@ -60,7 +60,7 @@ return [
]
```
# Yii Debug Module
## Yii Debug Module
You may want to enable the [Yii Debug Module](http://www.yiiframework.com/doc-2.0/ext-debug-index.html) for detailed
request and query debugging.
@ -82,6 +82,6 @@ return [
];
```
# Developer Tools Module
## Developer Tools Module
The [devtools Module](https://github.com/humhub/humhub-modules-devtools) provides some useful showcases of widgets and a module generator based on [Gii](https://www.yiiframework.com/doc/guide/2.0/en/start-gii).

View File

@ -5,8 +5,9 @@ HumHub provides a powerful modular platform based on the [Yii2 Framework](http:/
The modular nature of the HumHub platform allows you to add new features or change existing core features by means of
custom modules.
Other languages used throughout the platform, besides PHP, are JavaScript, HTML, SQL and CSS/Less.
HumHub is based on the [Model-View-Controller (MVC)](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) pattern and uses frontend technologies such as [jQuery](https://jquery.com/), [Bootstrap](http://getbootstrap.com/) and [Less](http://lesscss.org/).
Other languages used throughout the platform, besides **PHP**, are **JavaScript**, **HTML**, **SQL** and **CSS/Less**.
HumHub is based on the [Model-View-Controller (MVC)](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller)
pattern and uses frontend technologies such as [jQuery](https://jquery.com/), [Bootstrap](http://getbootstrap.com/) and [Less](http://lesscss.org/).
In this guide you will find all the necessary information to customize your HumHub installation and implement your own modules.
@ -36,12 +37,12 @@ HumHub extends several Yii base components such as:
and consists of the following core modules:
- **activity:** User/Space activities
- **activity:** Assambles social network activities
- **admin:** Responsible for admin/configuration related issues
- **comment:** Content addon for commenting
- **content:** Base module for all content types (Post,Wiki,...)
- **dashboard:** Dashboard related functionality
- **directory:** Directory related functionality
- **directory:** User/Space/Group directory
- **file:** Basic file module for accessing the filesystem
- **friendship:** User friendship module
- **installer:** HumHub installer module
@ -58,7 +59,7 @@ and consists of the following core modules:
- **ui:** Base ui components as widgets and theme logic
- **user:** Basic user module
### Application structure
### Core directories
```
assets/ - contains published asset files