diff --git a/peach-web/src/router.rs b/peach-web/src/router.rs index 38aed11..0872af0 100644 --- a/peach-web/src/router.rs +++ b/peach-web/src/router.rs @@ -26,7 +26,7 @@ pub fn mount_peachpub_routes(rocket: Rocket) -> Rocket { .mount( "/", routes![ - help, + guide, home, login, login_post, diff --git a/peach-web/src/routes/index.rs b/peach-web/src/routes/index.rs index e796c03..45eb21c 100644 --- a/peach-web/src/routes/index.rs +++ b/peach-web/src/routes/index.rs @@ -29,17 +29,17 @@ pub fn home(_auth: Authenticated, config: &State) -> Template { Template::render("home", &context.into_json()) } -// HELPERS AND ROUTES FOR /help +// HELPERS AND ROUTES FOR /guide -#[get("/help")] -pub fn help(flash: Option) -> Template { +#[get("/guide")] +pub fn guide(flash: Option) -> 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) -> Template { context.insert("flash_msg", &Some(flash.message().to_string())); }; - Template::render("help", &context.into_json()) + Template::render("guide", &context.into_json()) } diff --git a/peach-web/templates/guide.html.tera b/peach-web/templates/guide.html.tera new file mode 100644 index 0000000..07c850b --- /dev/null +++ b/peach-web/templates/guide.html.tera @@ -0,0 +1,33 @@ +{%- extends "nav" -%} +{%- block card %} + +
+
+ +
+ Getting started +

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 Sbot Configuration page to configure your system. The default configuration will be fine for most usecases.

+

Once the configuration is set, navigate to the Scuttlebutt settings menu 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: systemctl --user status go-sbot.service. The log output may give some clues about the source of the error.

+
+ +
+ Submit a bug report +

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.

+
+ +
+ Share feedback & request support +

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.

+

Alternatively, we have a Matrix channel for discussion about PeachCloud and you can also reach out to @glyph via email.

+
+ +
+ Contribute to PeachCloud +

PeachCloud is free, open-source software and relies on donations and grants to fund develop. Donations can be made on our OpenCollective page.

+

Programmers, designers, artists and writers are also welcome to contribute to the project. Please visit the main PeachCloud git repository to find out more details or contact the team via Scuttlebutt, Matrix or email.

+
+
+ + {% include "snippets/flash_message" %} +
+{%- endblock card -%} diff --git a/peach-web/templates/help.html.tera b/peach-web/templates/help.html.tera deleted file mode 100644 index 0109d1e..0000000 --- a/peach-web/templates/help.html.tera +++ /dev/null @@ -1,10 +0,0 @@ -{%- extends "nav" -%} -{%- block card %} - -
-
- - {% include "snippets/flash_message" %} -
-
-{%- endblock card -%} diff --git a/peach-web/templates/home.html.tera b/peach-web/templates/home.html.tera index 9013c7c..27ff7de 100644 --- a/peach-web/templates/home.html.tera +++ b/peach-web/templates/home.html.tera @@ -52,14 +52,14 @@ - +
- +