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

add markdownlint, fix formatting violations #119

Merged
merged 12 commits into from
Aug 2, 2023
Merged
20 changes: 20 additions & 0 deletions .github/workflows/markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Lint Markdown

on:
push

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: 18.x

- name: yarn install
run: yarn install

- name: yarn lint:md
run: yarn lint:md
7 changes: 7 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"ul-indent": { "indent": 4 },
"ul-style": { "style": "dash" },
"line-length": false,
"no-bare-urls": false,
"link-fragments": false
}
2 changes: 2 additions & 0 deletions .markdownlintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
i18n/
4 changes: 2 additions & 2 deletions docs/adguard-vpn-browser-extension/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ AdGuard VPN Browser extension is available for Chrome, Firefox, Opera, and Edge.

To manage your AdGuard VPN Browser extension:

* Either click its icon on the browser's panel, click the hamburger menu icon, and select *Settings*,
* Or go to the *Manage extensions* page in your browser, click *Details* below *AdGuard VPN* and manage its settings from there.
- Either click its icon on the browser's panel, click the hamburger menu icon, and select *Settings*,
- Or go to the *Manage extensions* page in your browser, click *Details* below *AdGuard VPN* and manage its settings from there.

Once done, you'll see several tabs on the left:

Expand Down
58 changes: 29 additions & 29 deletions docs/adguard-vpn-browser-extension/solving-problems/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,71 +7,71 @@ There are several ways for collecting AdGuard VPN Browser extension logs, but wh

## Collecting and sending logs via the *Report a bug* section

1. Open AdGuard VPN Browser extension, if possible, repeat the actions that led to the error. Note the exact time when this error occurred.
2. Open *Settings* by clicking the hamburger menu icon (☰) → *Support* → *Report a bug*.
3. In the opened form, leave an automatically inserted email address or enter another one and describe the error found, including the time when this error occurred. If you can't reproduce the problem, specify as accurately as possible when it last occurred.
4. Make sure that there is a check mark next to *Include the diagnostic report in the message*, and tap *Submit*. This way, you will send logs along with the bug report.
1. Open AdGuard VPN Browser extension, if possible, repeat the actions that led to the error. Note the exact time when this error occurred.
1. Open *Settings* by clicking the hamburger menu icon (☰) → *Support* → *Report a bug*.
1. In the opened form, leave an automatically inserted email address or enter another one and describe the error found, including the time when this error occurred. If you can't reproduce the problem, specify as accurately as possible when it last occurred.
1. Make sure that there is a check mark next to *Include the diagnostic report in the message*, and tap *Submit*. This way, you will send logs along with the bug report.

## Collecting and sending logs via the *Export logs* button

1. Open AdGuard VPN Browser extension, if possible, repeat the actions that led to the error. Note the exact time when this error occurred.
2. Right-click the AdGuard VPN Browser extension icon.
3. In the opened menu click *Export logs*.
4. As a result, the logs file will be saved to your device in `txt` format.
1. Open AdGuard VPN Browser extension, if possible, repeat the actions that led to the error. Note the exact time when this error occurred.
1. Right-click the AdGuard VPN Browser extension icon.
1. In the opened menu click *Export logs*.
1. As a result, the logs file will be saved to your device in `txt` format.

Now that you have collected the logs, you need to hand them over to our development team. To do this:
Now that you have collected the logs, you need to hand them over to our development team. To do this:

1. Report a bug on GitHub. Detailed instructions on creating an issue on GitHub can be found in this article.
2. Send an archive with logs and playback time to `devteam@adguard.com` and attach a link to your GitHub issue. Also you can add an archive with logs and playback time to Google Drive and share it with `devteam@adguard.com` attaching the Google Drive link to your issue on GitHub.
1. Report a bug on GitHub. Detailed instructions on creating an issue on GitHub can be found in this article.
1. Send an archive with logs and playback time to `devteam@adguard.com` and attach a link to your GitHub issue. Also you can add an archive with logs and playback time to Google Drive and share it with `devteam@adguard.com` attaching the Google Drive link to your issue on GitHub.

## Collecting and sending logs via browser developer's tools

### Chrome

1. Open AdGuard VPN Browser extension, if possible, repeat the actions that led to the error. Note the exact time when this error occurred.
2. Go to `chrome://extensions`
3. Turn on *developer mode*
1. Open AdGuard VPN Browser extension, if possible, repeat the actions that led to the error. Note the exact time when this error occurred.
1. Go to `chrome://extensions`
1. Turn on *developer mode*

![The developer mode *border](https://cdn.adguardvpn.com/content/kb/vpn/browser_extension/dev_mode.png)

4. Click `background.html`
1. Click `background.html`

![Background *border](https://cdn.adguardvpn.com/content/kb/vpn/browser_extension/backgroung.png)

5. Open the *Console tab*
1. Open the *Console tab*

![The Console tab *border](https://cdn.adguardvpn.com/content/kb/vpn/browser_extension/console.png)

6. Open the context menu and click *Save as…*
1. Open the context menu and click *Save as…*

![Save as *border](https://cdn.adguardvpn.com/content/kb/vpn/browser_extension/save.png)

Now that you have collected the logs, you need to hand them over to our development team. To do this:
Now that you have collected the logs, you need to hand them over to our development team. To do this:

1. Report a bug on GitHub. Detailed instructions on creating an issue on GitHub can be found in this article.
2. Send an archive with logs and playback time to `devteam@adguard.com` and attach a link to your GitHub issue. Also you can add an archive with logs and playback time to Google Drive and share it with `devteam@adguard.com` attaching the Google Drive link to your issue on GitHub.
1. Report a bug on GitHub. Detailed instructions on creating an issue on GitHub can be found in this article.
1. Send an archive with logs and playback time to `devteam@adguard.com` and attach a link to your GitHub issue. Also you can add an archive with logs and playback time to Google Drive and share it with `devteam@adguard.com` attaching the Google Drive link to your issue on GitHub.

### Firefox

1. Open AdGuard VPN Browser extension, if possible, repeat the actions that led to the error. Note the exact time when this error occurred.
2. Go to `about:addons`
3. Click *Debug Add-ons*
1. Open AdGuard VPN Browser extension, if possible, repeat the actions that led to the error. Note the exact time when this error occurred.
1. Go to `about:addons`
1. Click *Debug Add-ons*

![Debug Add-ons *border](https://cdn.adguardvpn.com/content/kb/vpn/browser_extension/add-ons.png)

4. Click *Inspect*
1. Click *Inspect*

![Inspect *border](https://cdn.adguardvpn.com/content/kb/vpn/browser_extension/inspect.png)

5. Go to the *Console* tab
1. Go to the *Console* tab

![Console *border](https://cdn.adguardvpn.com/content/kb/vpn/browser_extension/ff_console.png)

6. Click *Save all Messages to file*
1. Click *Save all Messages to file*

![Save *border](https://cdn.adguardvpn.com/content/kb/vpn/browser_extension/save-to-file.png)

Now that you have collected the logs, you need to hand them over to our development team. To do this:
Now that you have collected the logs, you need to hand them over to our development team. To do this:

1. Report a bug on GitHub. Detailed instructions on creating an issue on GitHub can be found in this article.
2. Send an archive with logs and playback time to `devteam@adguard.com` and attach a link to your GitHub issue. Also you can add an archive with logs and playback time to Google Drive and share it with `devteam@adguard.com` attaching the Google Drive link to your issue on GitHub.
1. Report a bug on GitHub. Detailed instructions on creating an issue on GitHub can be found in this article.
1. Send an archive with logs and playback time to `devteam@adguard.com` and attach a link to your GitHub issue. Also you can add an archive with logs and playback time to Google Drive and share it with `devteam@adguard.com` attaching the Google Drive link to your issue on GitHub.
4 changes: 2 additions & 2 deletions docs/adguard-vpn-for-android/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can find the AdGuard VPN for Android app in *Google Play* and install it for

2. Next, in the search bar, start typing *"AdGuard"* and select *"adguard vpn"* from the list of suggested options.

3. Select *AdGuard VPN - private proxy* from the list of suggested applications and tap *Install*.
3. Select *AdGuard VPN - private proxy* from the list of suggested applications and tap *Install*.

4. Wait for the installation to finish and tap *Open*.

Expand All @@ -24,4 +24,4 @@ AdGuard VPN for Android has been successfully installed!

If you decided to delete AdGuard VPN for Android, find the icon of this app and hold it. In the opened list, tap *Uninstall*.

You can learn more about the AdGuard VPN for Android in [this article](overview.md).
You can learn more about the AdGuard VPN for Android in [this article](overview.md)
6 changes: 3 additions & 3 deletions docs/adguard-vpn-for-android/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ A VPN is an ideal tool that provides security and anonymity each time you browse

**VPN is frequently used for:**

* Keeping personal data safe even while using public Wi-Fi
* Preventing online activity tracking by masking the IP address
* Hiding the real geolocation to remain anonymous
- Keeping personal data safe even while using public Wi-Fi
- Preventing online activity tracking by masking the IP address
- Hiding the real geolocation to remain anonymous

AdGuard VPN for Android can do it all for you — and even offer something unique. To find out why AdGuard VPN is the better option — read [this article](/general/why-adguard-vpn.md).

Expand Down
4 changes: 2 additions & 2 deletions docs/adguard-vpn-for-android/solving-problems/chromecast.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: 'Compatibility of AdGuard VPN with Chromecast'
sidebar_position: 5
---

The built-in Chromecast technology is incompatible with running a VPN because it uses the [DLNA protocol](https://en.wikipedia.org/wiki/Digital_Living_Network_Alliance) which does not support VPN connections. This means that if a Chromecast device and a smartphone or tablet running a VPN are on the same Wi-Fi network, in most cases Chromecast won't be recognised by the mobile device.
The built-in Chromecast technology is incompatible with running a VPN because it uses the [DLNA protocol](https://en.wikipedia.org/wiki/Digital_Living_Network_Alliance) which does not support VPN connections. This means that if a Chromecast device and a smartphone or tablet running a VPN are on the same Wi-Fi network, in most cases Chromecast won't be recognized by the mobile device.

Google has also blocked the ability to change the Chromecast's network settings by restricting access to its DNS settings. This also prevents Chromecast from working with a VPN.

You can solve the problem by setting up a VPN on a router. This will allow all devices connected to the router to use the VPN connection, including Chromecast. But remember: setting up a VPN on your router may require additional knowledge, so read the manufacturer's manual.
You can solve the problem by setting up a VPN on a router. This will allow all devices connected to the router to use the VPN connection, including Chromecast. But remember: setting up a VPN on your router may require additional knowledge, so read the manufacturer's manual.
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ title: Compatibility with AdGuard Ad Blocker
sidebar_position: 3
---


AdGuard VPN has the VPN operating mode enabled by default, which uses its own [AdGuard VPN protocol](/general/adguard-vpn-protocol.mdx). It provides the best combination of connection speed and security. However, this operating mode does not allow AdGuard VPN and AdGuard Ad Blocker to work simultaneously. The Compatibility mode, in turn, uses the IPsec protocol, which makes it possible for the AdGuard applications to work together. If you already have AdGuard Ad Blocker when installing AdGuard VPN, this mode will turn on automatically and allow you to use our applications at the same time. If you first installed AdGuard VPN, and only then decided to try AdGuard Ad Blocker, then to use them together, follow these steps:

1. Open AdGuard VPN for Android and select the gear icon at the bottom right of the screen.

2. Go to "Advanced settings" and select "Operating mode".

3. Switch the mode from to *Compatibility mode with AdGuard*. Done!
3. Switch the mode from to *Compatibility mode with AdGuard*. Done!
31 changes: 18 additions & 13 deletions docs/adguard-vpn-for-android/solving-problems/restricted-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,32 @@ You have two ways to solve the issue:
### Option 1: Grant permissions to AdGuard VPN using ADB

1. Activate the **developer mode** and enable **USB debugging**:
- Open the **Settings** application on your phone;
- Go to **System** section (last item in the settings menu). In this section find sub-item **About phone**;
- Click the **Build number** line 7 times. After that, you will receive a notification that **You are now a developer** (If necessary, enter an unlock code for the device);
- Open **System Settings** → **Developer Options** → Scroll down and enable **USB debugging** → Confirm debugging is enabled in the window **Allow USB debugging** after reading the warning carefully.

> If you have any difficulties or additional questions, full instructions can be found [here](https://developer.android.com/studio/debug/dev-options).
- Open the **Settings** application on your phone;
- Go to **System** section (last item in the settings menu). In this section find sub-item **About phone**;
- Click the **Build number** line 7 times. After that, you will receive a notification that **You are now a developer** (If necessary, enter an unlock code for the device);
- Open **System Settings** → **Developer Options** → Scroll down and enable **USB debugging** → Confirm debugging is enabled in the window **Allow USB debugging** after reading the warning carefully.

2. [Install and configure](https://www.xda-developers.com/install-adb-windows-macos-linux/) ADB;
> On the Windows platform, **Samsung** owners may need to install [this utility](https://developer.samsung.com/mobile/android-usb-driver.html).
> If you have any difficulties or additional questions, full instructions can be found [here](https://developer.android.com/studio/debug/dev-options).

3. Connect your device using a **USB cable** to the computer or laptop on which you installed **ADB**;
4. Open **the command line** on your PC:
- **Cmd.exe** if you are using **Windows**;
- **Terminal** if you are using **macOS**;
5. Enter the command `adb shell pm grant com.adguard.vpn android.permission.INTERACT_ACROSS_USERS` and press **Enter**.
1. [Install and configure](https://www.xda-developers.com/install-adb-windows-macos-linux/) ADB;

> On the Windows platform, **Samsung** owners may need to install [this utility](https://developer.samsung.com/mobile/android-usb-driver.html).

1. Connect your device using a **USB cable** to the computer or laptop on which you installed **ADB**;

1. Open **the command line** on your PC:

- **Cmd.exe** if you are using **Windows**;
- **Terminal** if you are using **macOS**;

1. Enter the command `adb shell pm grant com.adguard.vpn android.permission.INTERACT_ACROSS_USERS` and press **Enter**.

### Option 2: Remove *Restricted user account*

You can [find here](https://support.google.com/a/answer/6223444?hl=en) how to manage user accounts from an Android device.

> Please note, that in some cases restricted user accounts are created implicitly and cannot be removed. For instance, when you use Dual Messenger or Dual App features on **Samsung** or **LG** devices. Read below how to fix the issue in these cases.
> Please note that in some cases restricted user accounts are created implicitly and cannot be removed. For instance, when you use Dual Messenger or Dual App features on **Samsung** or **LG** devices. Read below how to fix the issue in these cases.

### LG and Samsung devices

Expand Down
14 changes: 7 additions & 7 deletions docs/adguard-vpn-for-ios/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ You can download and install the *AdGuard VPN for iOS* app for free in the *App

1. Open the *App Store* app on your device and tap *Search* in the bottom right corner of the screen.

![App Store](https://cdn.adguardvpn.com/content/kb/vpn/ios/app-store-en.png)
![App Store](https://cdn.adguardvpn.com/content/kb/vpn/ios/app-store-en.png)

2. Next, in the search bar, start typing *"AdGuard"* and select *"adguard vpn"* from the list of suggested options.
1. Next, in the search bar, start typing *"AdGuard"* and select *"adguard vpn"* from the list of suggested options.

![Search](https://cdn.adguardvpn.com/content/kb/vpn/ios/search-en.png)
![Search](https://cdn.adguardvpn.com/content/kb/vpn/ios/search-en.png)

3. Select *AdGuard VPN - Unlimited & Fast* from the list of suggested applications and tap *Download*. If necessary, enter your Apple ID account password in the opened window.
1. Select *AdGuard VPN - Unlimited & Fast* from the list of suggested applications and tap *Download*. If necessary, enter your Apple ID account password in the opened window.

![AdGuard VPN](https://cdn.adguardvpn.com/content/kb/vpn/ios/adguard-vpn-en.png)
![AdGuard VPN](https://cdn.adguardvpn.com/content/kb/vpn/ios/adguard-vpn-en.png)

4. Wait for the download to finish and tap *Open*.
1. Wait for the download to finish and tap *Open*.

AdGuard VPN for iOS has been successfully installed!

Expand All @@ -33,4 +33,4 @@ If you decided to delete AdGuard VPN for iOS, find the icon of this app on the H

![Uninstall](https://cdn.adguardvpn.com/public/Adguard/kb/vpn-install/deinstall-en.png)

You can learn more about the AdGuard VPN app for iOS in [this article](overview.md).
You can learn more about the AdGuard VPN app for iOS in [this article](overview.md).
9 changes: 5 additions & 4 deletions docs/adguard-vpn-for-ios/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ sidebar_position: 1
A VPN allows you to create a secure connection to another network on the Internet. It connects a user's computer or mobile device to a server and allows one to browse the net using someone else's IP address. So if the VPN server is located in a different country, it will appear that you have connected to the Internet from that country. [Learn more](/general/how-vpn-works.md) about how a VPN works in detail.

Speaking of AdGuard VPN, it has several functions:
* hides your real whereabouts and helps you stay anonymous
* сhanges your IP address to protect your data from tracking
* encrypts your traffic to make it unreachable to scammers
* lets you configure where to use VPN and where not to (exclusions feature)

- hides your real whereabouts and helps you stay anonymous
- changes your IP address to protect your data from tracking
- encrypts your traffic to make it unreachable to scammers
- lets you configure where to use VPN and where not to (exclusions feature)

The next advantage of AdGuard VPN for iOS is our own VPN protocol. It has two main benefits: comparing to other VPN protocols it is extremely hard to detect and it works stably even with a poor Internet connection. You can read more about AdGuard VPN protocol [in this article](../general/adguard-vpn-protocol.mdx).

Expand Down