Triplehx3/contentdb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
rubenwardy
2020-09-16 23:32:24 +01:00
parent a1e0e37223
commit d76f10c312
10 changed files with 271 additions and 242 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
app/flatpages/help/content_flags.md
View File

@@ -6,13 +6,22 @@ your client to use new flags.
## Flags
Minetest allows you to specify a comma-separated list of flags to hide in the
client:
```
contentdb_flag_blacklist = nonfree, bad_language, drugs
```
A flag can be:
* `nonfree` - can be used to hide packages which do not qualify as
'free software', as defined by the Free Software Foundation.
* A content warning, given below.
* `android_default` - meta-flag that filters out any content with a content warning.
* `desktop_default` - meta-flag that doesn't filter anything out for now.
## Warnings
## Content Warnings
Packages with mature content will be tagged with a content warning based
on the content type.

8
app/flatpages/help/non_free.md
View File

@@ -10,13 +10,13 @@ and they will be subject to limited promotion.
## How does ContentDB deal with Non-Free Licenses?
ContentDB does not allow certain non-free licenses, and will limit the promotion
of packages with non-free licenses.
**ContentDB does not allow certain non-free licenses, and will limit the promotion
of packages with non-free licenses.**
Minetest is free and open source software, and is only as big as it is now
because of this. It's pretty amazing you can take nearly any published mod and modify it
to how you like - add some features, maybe fix some bugs - and then share those
modifications without worry of legal issues. The project, itself, relies on open
modifications without the worry of legal issues. The project, itself, relies on open
source contributions to survive - if it were non-free, then it would have died
when celeron55 lost interest.
@@ -43,7 +43,7 @@ Here's a quick summary related to Minetest content:
you do want to allow derivative works or combinations.
This means that it can cause problems when another modder wishes to include your
work in a modpack or game.
2. They may rule out other basic and beneficial uses which you want to allow.
2. They may rule out other basic and beneficial uses that you want to allow.
For example, CC -NC will forbid showing your content in a monetised YouTube
video.
3. They are unlikely to increase the potential profit from your work, and a

34
app/flatpages/help/package_config.md
View File

@@ -2,12 +2,14 @@ title: Package Configuration and Releases Guide
## Introduction
ContentDB will read configuration files in your package when doing a number of
tasks, including package and release creation.
This page details the ways in which you can use this to your advantage.
ContentDB will read configuration files in your package when doing several
tasks, including package and release creation. This page details how you can use
this to your advantage.
## .conf files
### What is a content .conf file?
Every type of content can have a `.conf` file that contains the metadata.
The filename of the `.conf` file depends on the content type:
@@ -22,13 +24,15 @@ The `.conf` uses a key-value format, separated using equals. Here's a simple exa
name = mymod
description = A short description to show in the client.
### Understood values
ContentDB understands the following information:
* `description` - A short description to show in the client.
* `depends` - Comma-separated hard dependencies.
* `optional_depends` - Comma-separated soft dependencies.
* `min_minetest_version` - The minimum Minetest version this runs on.
* `max_minetest_version` - The maximum Minetest version this runs on.
* `min_minetest_version` - The minimum Minetest version this runs on, see [Min and Max Minetest Versions](#min_max_versions).
* `max_minetest_version` - The maximum Minetest version this runs on, see [Min and Max Minetest Versions](#min_max_versions).
and for mods only:
@@ -36,10 +40,12 @@ and for mods only:
## Controlling Release Creation
### Git Releases and Submodules
### Git-based Releases and Submodules
ContentDB can automatically create releases from a git repository.
ContentDB can create releases from a Git repository.
It will include submodules in the resulting archive.
Simply set VCS Repository in the package's meta to a Git repository, and then
choose Git as the method when creating a release.
### Automatic Release Creation
@@ -48,16 +54,26 @@ You can also use the [API](/help/api/) to create releases.
### Min and Max Minetest Versions
<a name="min_max_versions" />
When creating a release, the `.conf` file will be read to determine what Minetest
versions the release supports. If the `.conf` doesn't specify, then it is assumed
that is supports all versions.
that it supports all versions.
This happens when you create a release via the ContentDB web interface, the
[API](/help/api/), or using a [GitLab/GitHub webhook](/help/release_webhooks/).
Here's an example config:
name = mymod
min_minetest_version = 5.0
max_minetest_version = 5.3
Leaving out min or max to have them set as "None".
### Excluding files
When using git to create releases,
When using Git to create releases,
you can exclude files from a release by using [gitattributes](https://git-scm.com/docs/gitattributes):

372
app/flatpages/help/ranks_permissions.md
View File

@@ -3,24 +3,24 @@ title: Ranks and Permissions
## Overview
* **New Members** - mostly untrusted, cannot change package meta data or publish releases without approval.
* **Members** - Trusted to change the meta data of their own packages', but cannot publish releases.
* **Trusted Members** - Same as above, but can approve their own releases and packages.
* **Editors** - Trusted to change the meta data of any package, and also make and publish releases.
* **Members** - Trusted to change the meta data of their own packages', but cannot approve their own packages.
* **Trusted Members** - Same as above, but can approve their own releases.
* **Editors** - Trusted to edit any package or release, and also responsible for approving new packages.
* **Moderators** - Same as above, but can manage users.
* **Admins** - Full access.
## Breakdown
<table class="table">
<table class="table table-striped ranks-table">
<thead>
<tr>
<th>Rank</th>
<th colspan=2>New Member</th>
<th colspan=2>Member</th>
<th colspan=2>Trusted Member</th>
<th colspan=2>Editor</th>
<th colspan=2>Moderator</th>
<th colspan=2>Admin</th>
<th colspan=2 class="NEW_MEMBER">New Member</th>
<th colspan=2 class="MEMBER">Member</th>
<th colspan=2 class="TRUSTED_MEMBER">Trusted</th>
<th colspan=2 class="EDITOR">Editor</th>
<th colspan=2 class="MODERATOR">Moderator</th>
<th colspan=2 class="ADMIN">Admin</th>
</tr>
<tr>
<th>Owner of thing</th>
@@ -41,228 +41,228 @@ title: Ranks and Permissions
<tbody>
<tr>
<td>Create Package</td>
<th>✓</th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td>✓</td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td>✓</td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Approve Package</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th></th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td></td> <!-- new -->
<td></td>
<td></td> <!-- member -->
<td></td>
<td></td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td>✓</td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Delete Package</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th></th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td></td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td>✓</td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Edit Package</td>
<th></th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td></td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td>✓</td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Edit Maintainers</td>
<th>✓</th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th></th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td>✓</td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td></td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Add/Delete Screenshot</td>
<th>✓</th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td>✓</td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td>✓</td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Approve Screenshot</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td></td> <!-- new -->
<td></td>
<td></td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td>✓</td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Make Release</td>
<th>✓</th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td>✓</td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td>✓</td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Approve Release</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td></td> <!-- new -->
<td></td>
<td></td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td>✓</td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Change Release URL</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th></th> <!-- trusted member -->
<th></th>
<th></th> <!-- editor -->
<th></th>
<th></th> <!-- moderator -->
<th></th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td></td> <!-- new -->
<td></td>
<td></td> <!-- member -->
<td></td>
<td></td> <!-- trusted member -->
<td></td>
<td></td> <!-- editor -->
<td></td>
<td></td> <!-- moderator -->
<td></td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>See Private Thread</td>
<th>✓</th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td>✓</td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td>✓</td>
<td>✓</td> <!-- moderator -->
<td>✓</td>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Edit Comments</td>
<th></th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th></th>
<th>✓</th> <!-- moderator -->
<th></th>
<th>✓</th> <!-- admin -->
<th></th>
<td></td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td></td>
<td>✓</td> <!-- moderator -->
<td></td>
<td>✓</td> <!-- admin -->
<td></td>
</tr>
<tr>
<td>Set Email</td>
<th>✓</th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th></th>
<th>✓</th> <!-- moderator -->
<td>✓</td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td></td>
<td>✓</td> <!-- moderator -->
<th>✓<sup>2</sup></th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Create Token</td>
<th></th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- trusted member -->
<th></th>
<th>✓</th> <!-- editor -->
<th></th>
<th>✓</th> <!-- moderator -->
<td></td> <!-- new -->
<td></td>
<td>✓</td> <!-- member -->
<td></td>
<td>✓</td> <!-- trusted member -->
<td></td>
<td>✓</td> <!-- editor -->
<td></td>
<td>✓</td> <!-- moderator -->
<th>✓<sup>2</sup></th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
<tr>
<td>Set Rank</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th></th> <!-- trusted member -->
<th></th>
<th></th> <!-- editor -->
<th></th>
<td></td> <!-- new -->
<td></td>
<td></td> <!-- member -->
<td></td>
<td></td> <!-- trusted member -->
<td></td>
<td></td> <!-- editor -->
<td></td>
<th>✓<sup>3</sup></th> <!-- moderator -->
<th>✓<sup>2</sup><sup>3</sup></th>
<th>✓</th> <!-- admin -->
<th>✓</th>
<td>✓</td> <!-- admin -->
<td>✓</td>
</tr>
</tbody>
</table>

16
app/flatpages/help/release_webhooks.md
View File

@@ -63,15 +63,7 @@ The process is as follows:
## Configuring
### Setting minimum and maximum Minetest versions
1. Open up the conf file for the package.
This will be `game.conf`, `mod.conf`, `modpack.conf`, or `texture_pack.conf`
depending on the content type.
2. Set `min_minetest_version` and `max_minetest_version` to the respective Minetest versions.
Eg:
min_minetest_version = 5.0
Also see [Package Configuration and Releases Guide](/help/package_config/).
See the [Package Configuration and Releases Guide](/help/package_config/) for
documentation on configuring the release creation.
You can set the min/max Minetest version from the Git repository, and also
configure what files are included.