Skip to content

Commit 586951f

Browse files
committed
Fix formatting on all pages
1 parent f35d95e commit 586951f

21 files changed

+208
-125
lines changed

docs/acars/customization.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,11 @@ resized down to fit. Fill in the URLs to your logos. They should be PNG format
2626

2727
## Discord Rich Presence
2828

29-
:::tip This requires the ACARS Premium Addon :::
29+
:::tip
30+
31+
This requires the ACARS Premium Addon
32+
33+
:::
3034

3135
To customize the "Rich Presence" dialog in Discord, you need to create a new
3236
Application in Discord. You'll then enter the provided `Application ID` into the

docs/acars/install-server.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ title: Installation (Server)
55

66
## 1. Module Installation
77

8-
:::info The latest [dev](http://downloads.phpvms.net/phpvms-7.0.0-dev.tar.gz)
9-
versions of phpVMS are currently required :::
10-
118
For the server-side installation, extract the ACARS zip file, open the `Web`
129
folder and copy the `VMSAcars` into your `phpvms/modules` folder:
1310

docs/acars/user-guide.md

Lines changed: 26 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,23 @@ title: User Guide
77

88
---
99

10-
## .NET 6.0 Runtime
11-
12-
If you don't have this installed, ACARS will prompt you to download it. But if
13-
you want to download ahead of time, visit the
14-
[Download Page from Microsoft](https://dotnet.microsoft.com/en-us/download/dotnet/6.0/runtime),
15-
and select the x64 version for Desktop apps
16-
17-
![](img/runtime-path-dn6.png)
18-
1910
## ACARS Client
2011

2112
After downloading the zip, just extract the client into a folder (e.g, on your
2213
desktop into a folder called `ACARS`). Then you can create a desktop shortcut
2314
from the `acars.exe` for easier access.
2415

25-
:::caution vmsACARS files should NOT be placed in OneDrive synced
26-
locations/folders, if you have OneDrive installed and enabled please use another
27-
location other than your desktop or documents folders for acars extraction. :::
16+
:::danger
2817

29-
---
18+
vmsACARS files should **NOT** be placed in OneDrive synced locations/folders, if
19+
you have OneDrive installed and enabled please use another location other than
20+
your desktop or documents folders for acars extraction.
3021

31-
## Simulator Configuration
22+
:::
3223

3324
---
3425

35-
### FSX/Prepar3d Configuration
26+
## FSX/Prepar3d Configuration
3627

3728
To use FSX/Prepar3d, you need to install:
3829

@@ -42,7 +33,7 @@ To use FSX/Prepar3d, you need to install:
4233
After installing both, run `MakeRwys`. `MakeRwys` also needs to be re-run
4334
whenever there are scenery changes (if you want gates/runways to be updated).
4435

45-
### X-Plane Configuration
36+
## X-Plane Configuration
4637

4738
X-Plane uses a custom plugin. Open the `X-Plane` folder, and copy the
4839
`AcarsConnect` folder into your `Resources\plugins` folder.
@@ -55,9 +46,9 @@ selecting your X-Plane root/main folder.
5546

5647
![](img/xplane_button.png)
5748

58-
### MSFS Configuration
49+
## MSFS Configuration
5950

60-
#### WASM Module
51+
### WASM Module
6152

6253
If you're using Microsoft Flight Simulator, to read the LVars from the sim you
6354
need the `FSUIPC WASM Module (Version)` from [FSUIPC](https://www.fsuipc.com/) ,
@@ -66,23 +57,12 @@ folder.
6657

6758
![](img/fsuipc_lvar.png)
6859

69-
Also it is possible to install the WASM Module with FSUIPC main installer. While
70-
installing or updating it, be sure you have the WASM Module option enabled.
60+
Also, it is possible to install the WASM Module with FSUIPC main installer.
61+
While installing or updating it, be sure you have the WASM Module option
62+
enabled.
7163

7264
![](img/fsuipc_install.png)
7365

74-
#### Scenery
75-
76-
:::caution Due to an MSFS limitation, sceneries purchased through the MSFS store
77-
can't be scanned because they're encrypted. Only sceneries purchased outside of
78-
the store and manually placed in the `Community` directory can be scanned :::
79-
80-
To use MSFS, select "Microsoft Flight Simulator" from the simulator list and you
81-
will have two options:
82-
83-
- "Native" - this will try to scan all of the scenery folders and BGL files.
84-
- "MakeRwys" - this will use the MakeRwys output (same as P3D). The files output by `MakeRwys` need to be placed in the root of the `Community` folder
85-
8666
#### Permission Denied Errors
8767

8868
If you're getting a permission denied error, see
@@ -118,10 +98,14 @@ configuration/settings page:
11898
After entering your URL and API key, select the simulator, and then select the
11999
path to the simulator's root folder (for Fs9/FsX/Prepar3d or X-Plane)
120100

121-
:::info FSX/Prepar3d requires the `MakeRwys.exe` file, which can be downloaded
122-
from the [FSUIPC Page](http://fsuipc.simflight.com/beta/MakeRwys.zip). It needs
123-
to be placed in the same directory as FSX/Prepar3d, and it will create the
124-
required files needed to scan. :::
101+
:::info
102+
103+
FSX/Prepar3d requires the `MakeRwys.exe` file, which can be downloaded from the
104+
[FSUIPC Page](http://fsuipc.simflight.com/beta/MakeRwys.zip). It needs to be
105+
placed in the same directory as FSX/Prepar3d, and it will create the required
106+
files needed to scan.
107+
108+
:::
125109

126110
After selecting the directory, click `Re-Scan Scenery`. This will load the
127111
scenery database into ACARS for it to run/load later
@@ -148,8 +132,12 @@ Then click "Open In Guest", and you can follow the above instructions for then
148132
installing the plugin. Then, in ACARS, properly set the "Scenery Path" and IP to
149133
your Mac machine:
150134

151-
:::info If you configure it to point to the X-Plane root, the default share path
152-
for VMWare Fusion would be `\\vmware-host\Shared Folders\X-Plane 11`. :::
135+
:::info
136+
137+
If you configure it to point to the X-Plane root, the default share path for
138+
VMWare Fusion would be `\\vmware-host\Shared Folders\X-Plane 11`.
139+
140+
:::
153141

154142
![](img/vmware-acars-config.png)
155143

docs/config/backups.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ it if you want to create backups of your files and database.
1111
Backups are scheduled nightly, and an older backup is removed, ensuring you have
1212
multiple backups available (e.g., last night's, the one before, etc.).
1313

14-
:::caution Backups can consume up to 5GB of disk space. :::
14+
:::warning
15+
16+
Backups can consume a large amount of data and disk space
17+
18+
:::
1519

1620
## Basic Configuration
1721

docs/config/email.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,12 @@ These services are supported by Laravel natively;
1818
- [Amazon SES](https://aws.amazon.com/ses/) - Super cheap, free if you're using
1919
EC2
2020

21-
> [!IMPORTANT]
22-
> Do not forget cleaning application cache after editing `.env` variables.
23-
> Otherwise settings you defined/altered will not be loaded.
21+
:::warning
22+
23+
Do not forget cleaning application cache after editing `.env` variables.
24+
Otherwise, settings you defined/altered will not be loaded.
25+
26+
:::
2427

2528
---
2629

docs/config/files.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@ mail, and select configs from the `/config` directory. This file is used as an
2020
override (in the previous version of phpVMS, the `local.config.php` file is the
2121
same concept).
2222

23-
:::caution Don't change the files in the `/config` directory; instead, edit the
24-
`.env` file. This file will not be overwritten on an update. :::
23+
:::caution
24+
25+
Don't change the files in the `/config` directory; instead, edit the `.env`
26+
file. This file will not be overwritten on an update.
27+
28+
:::
2529

2630
See [Laravel configuration files](https://laravel.com/docs/9.x/configuration)
2731
for additional documentation.

docs/config/language.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,16 @@ title: Config Language
44
sidebar_title: Config Language
55
---
66

7-
# Change phpVMS Language
8-
97
It is possible to change the system language from one of the available
10-
languages.
11-
12-
To do this, consult the directory `phpvms/resources/lang/` to see the name of
13-
the available ones.
8+
languages. To do this, consult the directory `phpvms/resources/lang/` to see the
9+
name of the available ones.
1410

1511
Example: We want portuguese from brazil, We check that it is there
1612
`phpvms/resources/lang/pt-br`
1713

18-
Edit the `.env` file with your desire language name, pt-br in our example.
14+
Edit the `.env` file with your desire language name, `pt-br` in our example,
15+
add:
1916

20-
## `APP_LOCALE=pt-br`
17+
```
18+
APP_LOCALE=pt-br
19+
```

docs/config/optimizing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,11 @@ DEBUG_TOOLBAR=false
5858
Sessions store the logged in users and other information. By default, they're
5959
stored on disk.
6060

61-
:::info The Redis store is recommended if you have access to it :::
61+
:::info
62+
63+
The Redis store is recommended if you have access to it
64+
65+
:::
6266

6367
#### Redis
6468

docs/customize/layouts.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,14 @@ All of the themes are stored in the `resources/views/layouts/` folder. There is
1414
a base theme file, `app.blade.php`, which is then used by the templates. It has
1515
several required sections:
1616

17-
:::info See the `resources/views/layouts/default/app.blade.php` as an example
18-
template, since there are several sections of code which are required in any
19-
custom templates, including some Javascript and CSS. I've tried to make notes
20-
and outline those sections in the `default/app.blade.php` file itself. :::
17+
:::info
18+
19+
See the `resources/views/layouts/default/app.blade.php` as an example template,
20+
since there are several sections of code which are required in any custom
21+
templates, including some Javascript and CSS. I've tried to make notes and
22+
outline those sections in the `default/app.blade.php` file itself.
23+
24+
:::
2125

2226
- `@section('title')` is the page title, and shows up in the title bar
2327
- `@section('content')` is the main content for the page

docs/customize/theming.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@ know what you've modified).
3636

3737
### New Theme from Scratch
3838

39-
:::tip You can use `theme:create` command to bootstrap these steps :::
39+
:::tip
40+
41+
You can use `theme:create` command to bootstrap these steps
42+
43+
:::
4044

4145
Into the root of the `resources/views/layouts/` path, create a new folder, with
4246
a `theme.json` file. This JSON file serves as the manifest for your theme

docs/developers/building-assets.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,14 @@ Each of those folders have a `js` and `css` folder, and the respective assets
4545
are placed in those folders. After building those assets, the files are placed
4646
into there.
4747

48-
:::caution On an update, the files in `public/assets/*` will be overwritten, so
49-
be careful when updating to make sure those files aren't overwritten. You can do
50-
a diff against the original JS files in `resources/js` and then rebuild, to make
51-
sure your changes are included :::
48+
:::caution
49+
50+
On an update, the files in `public/assets/*` will be overwritten, so be careful
51+
when updating to make sure those files aren't overwritten. You can do a diff
52+
against the original JS files in `resources/js` and then rebuild, to make sure
53+
your changes are included
54+
55+
:::
5256

5357
---
5458

docs/developers/environment.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,32 @@ title: Environment Configuration
77

88
This is for running a local configuration, for running unit-tests, etc.
99

10-
:::info This is just how I work on phpVMS, to quickly reset the database and
10+
:::note
11+
12+
This is just how I work on phpVMS, to quickly reset the database and
1113
test/develop items locally, without having to transfer files anywhere. I mainly
1214
use the Docker Compose setup
1315

1416
If you're on Windows, I highly recommend installing WSL with your distro of
1517
choice (I use Ubuntu). If you don't have `make` available, open the `Makefile`
1618
and look for the commands to run for the individual commands of what you're
17-
trying to run. :::
18-
19-
:::info You may want to disable caching during development phases to ensure your
20-
changes are applied correctly, as caching cna prevent changes from taking
21-
effect. To do this, set `CACHE_DRIVER=null` in your `.env` file.
19+
trying to run.
2220

2321
:::
2422

25-
:::info We strongly recommend reading the
23+
### Disable Caching
24+
25+
You may want to disable caching during development phases to ensure your changes
26+
are applied correctly, as caching cna prevent changes from taking effect. To do
27+
this, set `CACHE_DRIVER=null` in your `.env` file.
28+
29+
### Laravel Documentation
30+
31+
We strongly recommend reading the
2632
[Laravel Documentation](https://laravel.com/docs/10.x), as it's more detailed
2733
and up-to-date. Since phpVMS is based on Laravel, the installation process is
2834
the same. In addition, you can simply use the `php artisan phpvms:dev-install`
29-
command to set up a development database. :::
35+
command to set up a development database.
3036

3137
## Creating and Resetting the Environment with docker
3238

docs/help.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,12 @@ This guide details the requirements for getting help with phpVMS or vmsACARS.
77

88
## How to ask for help
99

10-
:::info Before asking for help, try to reproduce on the
11-
[demo site](https://demo.phpvms.net), and with the `default` skin :::
10+
:::info
11+
12+
Before asking for help, try to reproduce on the
13+
[demo site](https://demo.phpvms.net), and with the `default` skin
14+
15+
:::
1216

1317
Without a lot of this information, it will be difficult to provide help.
1418

docs/installation/cron.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,23 @@ Some of the features that rely on cronjobs include:
1010
- Finances
1111
- vaCentral features
1212

13-
:::note If you can't run it once a minute, the lowest interval possible is fine,
14-
but should be in 5 minute increments, since there are tasks that run at 5,15,
15-
and 30 minute intervals. :::
16-
17-
:::tip Info about "Shared Hosting" Many hosts limit the usage of cron, either by
18-
limiting it directly or limiting php extensions needed by cron. So if you are
19-
planning to use a "Shared Hosting", better to focus on cron and email settings
20-
first (specially if they offer a money back quarantee), if cron is failing and
21-
you can not get it working properly consider finding a different service
22-
provider. Even some hosts limit WebCron services, be advised, without a working
23-
cron you will not get the best of phpVMS v7. :::
13+
:::note
2414

25-
---
15+
If you can't run it once a minute, the lowest interval possible is fine, but
16+
should be in 5 minute increments, since there are tasks that run at 5,15, and 30
17+
minute intervals.
18+
19+
:::
20+
21+
## Info about "Shared Hosting"
22+
23+
Many hosts limit the usage of cron, either by limiting it directly or limiting
24+
php extensions needed by cron. So if you are planning to use a "Shared Hosting",
25+
better to focus on cron and email settings first (specially if they offer a
26+
money back quarantee), if cron is failing and you can not get it working
27+
properly consider finding a different service provider. Even some hosts limit
28+
WebCron services, be advised, without a working cron you will not get the best
29+
of phpVMS v7.
2630

2731
## Configuration on a Server
2832

@@ -52,9 +56,13 @@ phpVMS, in the admin panel, can suggest a cron path/command for you, under
5256
`Admin -> Maintenance`. However, before trying that, try setting it up according
5357
to your host's instructions.
5458

55-
:::tip Note the "Domain Specific Example" Many hosts offer multiple PHP
56-
versions, make sure to use the path to the PHP 7.x version in the cronjob.
57-
Contact your host! Point them to this page. The example below uses PHP 7.4. :::
59+
:::tip
60+
61+
Note the "Domain Specific Example" Many hosts offer multiple PHP versions, make
62+
sure to use the path to the PHP 7.x version in the cronjob. Contact your host!
63+
Point them to this page. The example below uses PHP 7.4.
64+
65+
:::
5866

5967
With cPanel, select "Once Per Minute" under "Common Settings", and you can use a
6068
similar command.

0 commit comments

Comments
 (0)