Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix guides according to vale linter recommendations #194

Merged
merged 18 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/styles/.vale-config/0-Hugo.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[*.md]
# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
(\[.+\]\({{< .+ >}}\)), \
({{[%<] .+ [%>]}})

# Exclude `{{< myshortcode `This is some <b>HTML</b>, ... >}}`
BlockIgnores = (?sm)^({{[%<] [^{]*? [%>]}})\n$, \
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}}), \
({{[%<] .+ [%>]}})
4 changes: 4 additions & 0 deletions .github/styles/config/vocabularies/Doc/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ Hextra
shortcode
OAuth
cron
Moodle
application
rclone

1 change: 1 addition & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Packages = Hugo, Google
[*.md]
BasedOnStyles = Vale, Google
Google.Headings = NO
Vale.Terms = NO

[*.xml]
Transform = docbook-xsl-snapshot/html/docbook.xsl
14 changes: 7 additions & 7 deletions content/guides/moodle.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type: docs
educators, administrators and learners with a single robust, secure and
integrated system to create personalised learning environments.

This doc explains how to configure Moddle from source. Alternatively, an already configured repository exists as well on [Clever Cloud's GitHub page](https://github.com/CleverCloud/moodle).
This doc explains how to configure Moodle from source. Alternatively, an already configured repository exists as well on [Clever Cloud's GitHub page](https://github.com/CleverCloud/moodle).

## How to Configure and Deploy Moodle on Clever Cloud

Expand Down Expand Up @@ -72,7 +72,7 @@ Commit changes.

### Declare the PHP Application

On Clever Cloud Console, click on **Create** > **An application** and choose a [PHP](/doc/applications/php) application with Git deployment. Add a [MySQL](/doc/addons/mysql) add-on during the process.
On Clever Cloud Console, click **Create** > **An application** and choose a [PHP](/doc/applications/php) application with Git deployment. Add a [MySQL](/doc/addons/mysql) add-on during the process.

### Set Up Environment Variables

Expand All @@ -84,13 +84,13 @@ MAX_INPUT_VARS="5000"
URL="<your-url"
```

If you don't have an domain for your Moodle applicaiton yet, you'll be able to add a test domain provided by Clever Cloud in step 6.
If you don't have an domain for your Moodle application yet, you'll be able to add a test domain provided by Clever Cloud in step 6.

### Set Up `moodledata` Folder

This step will allow you to store your files outside of your application and [is required by Moodle to run](https://docs.moodle.org/403/en/Site_backup). All uploaded files and appearence set ups will be stored in a [File System Bucket](/doc/addons/fs-bucket) away from the appmlication server, as recommended by Moodle.
In this step you enable storage outside of your application, which [Moodle requires to run](https://docs.moodle.org/403/en/Site_backup). Use a [File System Bucket](/doc/addons/fs-bucket) to store all uploaded files and appearance set ups away from the application server, as recommended by Moodle.

Create an **FS Bucket add-on** and link it to your PHP application. In your FS Bucket dashboard, find the path variable (it should look like this: `CC_FS_BUCKET=/some/empty/folder:bucket-<bucket_id>`)
Create an **FS Bucket add-on** and link it to your PHP application. In your FS Bucket dashboard, find the path variable. It should look like this: `CC_FS_BUCKET=/some/empty/folder:bucket-<bucket_id>`.

Add this variable to your **PHP application** and replace `/some/empty/folder` by `/moodledata`. Don't forget to **update changes**.

Expand Down Expand Up @@ -122,9 +122,9 @@ Create a `clevercloud/cron.json` file with a string to run `admin/cli/cron.php`e
]
```

You might encounter errors when the Cron tries to access `moodledata` in your FS Bucket. For FS Bucket backups, we reccomend you to use a dedicated tool like [rclone](https://rclone.org).
You might encounter errors when the Cron tries to access `moodledata` in your FS Bucket. For FS Bucket backups, look for a dedicated tool like [rclone](https://rclone.org).

**Note**: this repository is already configured to run `/admin/cli/cron.php` every minute as a [cron job](https://developers.clever-cloud.com/doc/administrate/cron/)).
**Note**: this repository is already configured to run `/admin/cli/cron.php` every minute as a [cron job](https://developers.clever-cloud.com/doc/administrate/cron/).

## 🎓 Further Help

Expand Down
Loading