LibreGaming
/
contentdb
14
0
Fork 0
Code Issues 13 Pull Requests Projects Releases Wiki Activity

Add help pages

This commit is contained in:
rubenwardy 2018-05-14 14:46:41 +01:00
parent 661bb19de7
commit 1e440d4523
No known key found for this signature in database
GPG Key ID: A1E29D52FF81513C
7 changed files with 248 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
app/__init__.py
View File

@ -5,9 +5,12 @@ from flask_mail import Mail
from flask.ext import markdown
from flask_github import GitHub
from flask_wtf.csrf import CsrfProtect
from flask_flatpages import FlatPages
import os
app = Flask(__name__)
app.config["FLATPAGES_ROOT"] = "flatpages"
app.config["FLATPAGES_EXTENSION"] = ".md"
app.config.from_pyfile(os.environ["FLASK_CONFIG"])
menu.Menu(app=app)
@ -15,6 +18,7 @@ markdown.Markdown(app, extensions=["fenced_code"], safe_mode=True, output_format
github = GitHub(app)
csrf = CsrfProtect(app)
mail = Mail(app)
pages = FlatPages(app)
from . import models, tasks
from .views import *

3
app/flatpages/help.md Normal file
View File

@ -0,0 +1,3 @@
title: Help
* [Ranks and Permissions](ranks_permissions)

173
app/flatpages/help/ranks_permissions.md Normal file
View File

@ -0,0 +1,173 @@
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.
* **Editors** - Trusted to change the meta data of any package, and also make and publish releases.
* **Moderators** - Same as above, but can manage users.
* **Admins** - Full access.
## Breakdown
<table>
<thead>
<tr>
<th>Rank</th>
<th colspan=2>New Member</th>
<th colspan=2>Member</th>
<th colspan=2>Editor</th>
<th colspan=2>Moderator</th>
<th colspan=2>Admin</th>
</tr>
<tr>
<th>Owner of thing</th>
<th>Y</th>
<th>N</th>
<th>Y</th>
<th>N</th>
<th>Y</th>
<th>N</th>
<th>Y</th>
<th>N</th>
<th>Y</th>
<th>N</th>
</tr>
</thead>
<tbody>
<tr>
<td>Create Package</td>
<th>✓</th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
<tr>
<td>Approve Package</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
<tr>
<td>Edit Package</td>
<th></th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
<tr>
<td>Approve EditRequest</td>
<th></th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
<tr>
<td>Edit EditRequest</td>
<th>✓<sup>1</sup></th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
<tr>
<td>Make Release</td>
<th>✓</th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
<tr>
<td>Approve Release</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th>✓</th> <!-- editor -->
<th>✓</th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
<tr>
<td>Change Release URL</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th></th> <!-- editor -->
<th></th>
<th></th> <!-- moderator -->
<th></th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
<tr>
<td>Set Email</td>
<th>✓</th> <!-- new -->
<th></th>
<th>✓</th> <!-- member -->
<th></th>
<th>✓</th> <!-- editor -->
<th></th>
<th>✓</th> <!-- moderator -->
<th>✓<sup>2</sup></th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
<tr>
<td>Set Rank</td>
<th></th> <!-- new -->
<th></th>
<th></th> <!-- member -->
<th></th>
<th></th> <!-- editor -->
<th></th>
<th>✓</th> <!-- moderator -->
<th>✓</th>
<th>✓</th> <!-- admin -->
<th>✓</th>
</tr>
</tbody>
</table>
1. User must be the author of the EditRequest.
2. Target user cannot be an admin.

48
app/scss/components.scss
View File

@ -150,3 +150,51 @@ a:hover {
background: #161;
border: 1px solid #393;
}
table {
font-family: "Arial Black", Gadget, sans-serif;
border: 2px solid #000000;
background-color: #4A4A4A;
width: 100%;
text-align: center;
border-collapse: collapse;
}
table td, table th {
border: 1px solid #4A4A4A;
padding: 3px 2px;
}
table tbody td {
font-size: 13px;
color: #E6E6E6;
}
table tr:nth-child(even) {
background: #888888;
}
table thead {
background: #000000;
border-bottom: 3px solid #000000;
}
table thead th {
font-size: 15px;
font-weight: bold;
color: #E6E6E6;
text-align: center;
border-left: 2px solid #4A4A4A;
}
table thead th:first-child {
border-left: none;
}
table tfoot {
font-size: 12px;
font-weight: bold;
color: #E6E6E6;
background: #000000;
background: -moz-linear-gradient(top, #404040 0%, #191919 66%, #000000 100%);
background: -webkit-linear-gradient(top, #404040 0%, #191919 66%, #000000 100%);
background: linear-gradient(to bottom, #404040 0%, #191919 66%, #000000 100%);
border-top: 1px solid #4A4A4A;
}
table tfoot td {
font-size: 12px;
}

11
app/templates/flatpage.html Normal file
View File

@ -0,0 +1,11 @@
{% extends "base.html" %}
{% block title %}
{{ page['title'] }}
{% endblock %}
{% block content %}
<h1>{{ page['title'] }}</h1>
{{ page.html | safe }}
{% endblock %}

9
app/views/__init__.py
View File

@ -1,4 +1,4 @@
from app import app
from app import app, pages
from flask import *
from flask_user import *
from flask_login import login_user, logout_user
@ -31,3 +31,10 @@ def home_page():
return render_template("index.html", packages=packages)
from . import users, githublogin, packages, sass, tasks, admin, notifications
@menu.register_menu(app, ".help", "Help", order=19, endpoint_arguments_constructor=lambda: { 'path': 'help' })
@app.route('/<path:path>/')
def flatpage(path):
page = pages.get_or_404(path)
template = page.meta.get('template', 'flatpage.html')
return render_template(template, page=page)

1
requirements.txt
View File

@ -10,3 +10,4 @@ celery==4.0.2
redis==2.10.6
beautifulsoup4==4.6.0
lxml==4.2.1
Flask-FlatPages==0.6