PeachCloud/peach-workspace
3
2
Fork 1
Code Issues 17 Pull Requests 1 Projects Releases Wiki Activity

change help to guide and add text

Browse Source
This commit is contained in:
glyph
2022-03-07 11:35:19 +02:00
parent af34829cb0
commit 1a8ac3f57f
5 changed files with 41 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
peach-web/src/router.rs
View File

@ -26,7 +26,7 @@ pub fn mount_peachpub_routes(rocket: Rocket<Build>) -> Rocket<Build> {
.mount(
"/",
routes![
help,
guide,
home,
login,
login_post,

10
peach-web/src/routes/index.rs
View File

@ -29,17 +29,17 @@ pub fn home(_auth: Authenticated, config: &State<RocketConfig>) -> Template {
Template::render("home", &context.into_json())
}
// HELPERS AND ROUTES FOR /help
// HELPERS AND ROUTES FOR /guide
#[get("/help")]
pub fn help(flash: Option<FlashMessage>) -> Template {
#[get("/guide")]
pub fn guide(flash: Option<FlashMessage>) -> Template {
// retrieve current ui theme
let theme = utils::get_theme();
let mut context = Context::new();
context.insert("theme", &theme);
context.insert("back", &Some("/".to_string()));
context.insert("title", &Some("Help".to_string()));
context.insert("title", &Some("Guide".to_string()));
// check to see if there is a flash message to display
if let Some(flash) = flash {
@ -47,5 +47,5 @@ pub fn help(flash: Option<FlashMessage>) -> Template {
context.insert("flash_msg", &Some(flash.message().to_string()));
};
Template::render("help", &context.into_json())
Template::render("guide", &context.into_json())
}

33
peach-web/templates/guide.html.tera Normal file
View File

@ -0,0 +1,33 @@
{%- extends "nav" -%}
{%- block card %}
<!-- GUIDE -->
<div class="card card-wide center">
<div class="capsule capsule-container border-info">
<!-- GETTING STARTED -->
<details>
<summary class="card-text link">Getting started</summary>
<p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;">The Scuttlebutt server (sbot) will be inactive when you first run PeachCloud. This is to allow configuration parameters to be set before it is activated for the first time. Navigate to the <a href="/settings/scuttlebutt/configure" class="link font-gray">Sbot Configuration</a> page to configure your system. The default configuration will be fine for most usecases.</p>
<p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;">Once the configuration is set, navigate to the <a href="/settings/scuttlebutt" class="link font-gray">Scuttlebutt settings menu</a> to start the sbot. If the server starts successfully, you will see a green smiley face on the home page. If the face is orange and sleeping, that means the sbot is still inactive (ie. the process is not running). If the face is red and dead, that means the sbot failed to start - indicated an error. For now, the best way to gain insight into the problem is to check the systemd log. Open a terminal and enter: <code>systemctl --user status go-sbot.service</code>. The log output may give some clues about the source of the error.</p>
</details>
<!-- BUG REPORTS -->
<details>
<summary class="card-text link">Submit a bug report</summary>
<p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;">Bug reports can be submitted by filing an issue on the peach-workspace git repo. Before filing a report, first check to see if an issue already exists for the bug you've encountered. If not, you're invited to submit a new report; the template will guide you through several questions.</p>
</details>
<!-- REQUEST SUPPORT -->
<details>
<summary class="card-text link">Share feedback & request support</summary>
<p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;">You're invited to share your thoughts and experiences of PeachCloud in the #peachcloud channel on Scuttlebutt. The channel is also a good place to ask for help.</p>
<p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;">Alternatively, we have a <a href="https://matrix.to/#/#peachcloud:matrix.org" class="link font-gray">Matrix channel</a> for discussion about PeachCloud and you can also reach out to @glyph <a href="mailto:glyph@mycelial.technology" class="link font-gray">via email</a>.</p>
</details>
<!-- CONTRIBUTE -->
<details>
<summary class="card-text link">Contribute to PeachCloud</summary>
<p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;">PeachCloud is free, open-source software and relies on donations and grants to fund develop. Donations can be made on our <a href="https://opencollective.com/peachcloud" class="link font-gray">OpenCollective</a> page.</p>
<p class="card-text" style="margin-top: 1rem; margin-bottom: 1rem;">Programmers, designers, artists and writers are also welcome to contribute to the project. Please visit the <a href="https://git.coopcloud.tech/PeachCloud/peach-workspace" class="link font-gray">main PeachCloud git repository</a> to find out more details or contact the team via Scuttlebutt, Matrix or email.</p>
</details>
</div>
<!-- FLASH MESSAGE -->
{% include "snippets/flash_message" %}
</div>
{%- endblock card -%}

10
peach-web/templates/help.html.tera
View File

@ -1,10 +0,0 @@
{%- extends "nav" -%}
{%- block card %}
<!-- HELP MENU -->
<div class="card center">
<div class="capsule capsule-container border-info">
<!-- FLASH MESSAGE -->
{% include "snippets/flash_message" %}
</div>
</div>
{%- endblock card -%}

4
peach-web/templates/home.html.tera
View File

@ -52,14 +52,14 @@
</a>
<!-- bottom-middle -->
<!-- PEACHCLOUD GUIDEBOOK LINK AND ICON -->
<a class="bottom-middle" href="/help" title="Help Menu">
<a class="bottom-middle" href="/guide" title="Guide">
<div class="circle circle-small border-circle-small border-info">
<img class="icon-medium" src="/icons/book.svg">
</div>
</a>
<!-- bottom-right -->
<!-- SYSTEM SETTINGS LINK AND ICON -->
<a class="bottom-right" href="/settings" title="Settings Menu">
<a class="bottom-right" href="/settings" title="Settings">
<div class="circle circle-small border-circle-small border-settings">
<img class="icon-medium" src="/icons/cog.svg">
</div>