-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #552 from G-Core/main
main to dev
- Loading branch information
Showing
38 changed files
with
752 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
documentation/account-settings/propose-changes-to-articles-on-github.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
--- | ||
title: propose-changes-to-articles-on-github | ||
displayName: Change articles on GitHub | ||
published: true | ||
order: 95 | ||
toc: | ||
pageTitle: A guide on how to change articles on GitHub | Gcore | ||
pageDescription: A comprehensive guide on how to propose changes to articles of the Gcore Product Documentation on GitHub. | ||
--- | ||
# How to propose changes to Gcore Product Documentation articles on GitHub | ||
|
||
|
||
1\. Open any article in the <a href="https://gcore.com/docs/" target="_blank">Product Documentation</a> section and scroll down to the footer. Click **Edit on GitHub**. In the example below we open the <a href="https://gcore.com/docs/account-settings/password/what-to-do-if-you-forget-your-password" target="_blank">What to do if you forget your password?</a> guide. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/edit-on-github-1.png" alt="Edit on GitHub" width="80%"> | ||
|
||
2\. The new page will open. Click **Edit on GitHub** again. Under the button, you will see a duplicate of this guide on how to propose changes. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/edit-on-gh-2.png" alt="Edit on GitHub" width="70%"> | ||
|
||
3\. <a href="https://github.com/login" target="_blank">Sign in</a> to your GitHub account. | ||
|
||
4\. (First time only) Click **Fork this repository**. This will copy the Gcore ```product-documentation``` repository to your account. Next time you propose changes to our articles, this page will not be there. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-10.png" alt="Fork this repository function on GitHub" width="80%"> | ||
|
||
5\. Select the appropriate action from the options below, and follow the instructions. | ||
|
||
<expandable-element title="Correct text: errors, typos, irrelevant product information"> | ||
|
||
1\. Make edits in the field, click **Commit changes...** and then click **Propose changes** in the pop-up. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-20.gif" alt="How to propose changes if you want to correct text" width="80%"> | ||
|
||
2\. Click **Create pull request**. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-30.png" alt="Create pull request function on GitHub" width="80%"> | ||
|
||
3\. Click **Create pull request** again. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-40.png" alt="Create pull request function on GitHub" width="80%"> | ||
|
||
That’s it. The Gcore technical writers will be notified of your request and will process it. You will receive a message to your GitHub account email about their decision. | ||
|
||
</expandable-element> | ||
|
||
<expandable-element title="Correct an invalid link"> | ||
|
||
1\. Remove the incorrect information from the <code><a href="https://wrong-link"></code> attribute. Insert the correct <code><a href="https://right-link"></code> link in its place, click <b>Commit changes…</b>, and then click <b>Propose changes</b> in the pop-up. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-v2-50.gif" alt="How to propose changes if you want to correct a link" width="80%"> | ||
|
||
2\. Click **Create pull request**. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-30.png" alt="Create pull request function on GitHub" width="80%"> | ||
|
||
3\. Click **Create pull request** again. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-40.png" alt="Create pull request function on GitHub" width="80%"> | ||
|
||
That’s it. The Gcore technical writers will be notified of your request and will process it. You will receive a message to your GitHub account email about their decision. | ||
|
||
</expandable-element> | ||
|
||
<expandable-element title="Report an incorrect screenshot or layout error"> | ||
|
||
**Note**: You cannot fix a screenshot or a layout error (button or content does not work, block is displayed incorrectly, etc.) in the product documentation yourself. If you find errors of this kind, let us know and we’ll fix it. | ||
|
||
1\. To delete a screenshot or a fragment with an error, click **Commit changes** in the pop-up that appears, describe the error, and click **Propose changes**. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-60.gif" alt="How to propose changes if you want to correct a screenshot" width="80%"> | ||
|
||
2\. Click **Create pull request**. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-30.png" alt="Create pull request function on GitHub" width="80%"> | ||
|
||
3\. Click **Create pull request** again. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-40.png" alt="Create pull request function on GitHub" width="80%"> | ||
|
||
That’s it. The Gcore technical writers will be notified of your request and will process it. You will receive a message to your GitHub account email about their decision. | ||
|
||
</expandable-element> | ||
|
||
<expandable-element title="Leave a comment"> | ||
|
||
If you found an error in the text and do not want to correct it yourself, follow these steps: | ||
|
||
1\. Highlight the text fragment with the error, delete it, or write a suggestion to enable comments. Click **Commit changes**, describe the error in the popup, and click **Propose changes**. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-70.gif" alt="How to propose changes if you want to let us know about corrections" width="80%"> | ||
|
||
2\. Click **Create pull request**. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-30.png" alt="Create pull request function on GitHub" width="80%"> | ||
|
||
3\. Click **Create pull request** again. | ||
|
||
<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-40.png" alt="Create pull request function on GitHub" width="80%"> | ||
|
||
That’s it. The Gcore technical writers will be notified of your request and will process it. You will receive a message to your GitHub account email about their decision. | ||
|
||
</expandable-element> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
documentation/cdn/cdn-resource-options/cdn-security/metada.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: metadata | ||
displayName: Security | ||
published: true | ||
order: 35 | ||
--- |
48 changes: 48 additions & 0 deletions
48
...n/cdn/cdn-resource-options/cdn-security/protect-cdn-resources-with-basic-waf.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: protect-cdn-resources-with-basic-waf | ||
displayName: Basic WAF (Beta) | ||
published: true | ||
order: 10 | ||
toc: | ||
--1--Basic WAF: "what-is-basic-waf-beta" | ||
--1--Enable: "how-to-enable-basic-waf" | ||
--2--CDN resource: "cdn-resource" | ||
--2--Specific URLs: "specific-urls" | ||
--1--Basic WAF blocks some unwanted content: "what-to-do-if-basic-waf-blocks-some-content-that-should-not-be-blocked" | ||
pageTitle: Protection from cyberthreads with Gcore Basic WAF | Gcore | ||
pageDescription: A comprehensive guide on how to protect the entire CDN resource or specific urls. | ||
--- | ||
# Protect CDN resources with Basic WAF | ||
|
||
## What is Basic WAF (Beta)? | ||
|
||
Basic WAF is the firewall that protects you against the most widespread cyberthreats. The feature is available in beta testing and is available for free. The volume of requests per resource that can be safeguarded by the firewall may be subject to limitations. | ||
|
||
## How to enable Basic WAF | ||
|
||
You can activate the firewall for the entire CDN resource or specific URLs. | ||
|
||
### CDN resource | ||
|
||
To enable Basic WAF for an entire CDN resource: | ||
|
||
1. Go to the **Security** section in the Resource settings. | ||
2. Toggle on the **Enable Basic WAF** feature. | ||
3. Save changes. | ||
|
||
<img src="https://assets.gcore.pro/docs/cdn/cdn-resource-options/cdn-security/protect-cdn-resources-with-basic-waf/basic-waf-10.png" alt="Enabling Basic WAF for the entire CDN resource"> | ||
|
||
### Specific URLs | ||
|
||
To apply Basic WAF to particular files, in the CDN resource settings (“Rules” tab), create a rule where you specify URLs or regular expressions and enable the Basic WAF feature for them. To do that, <a href="https://gcore.com/docs/cdn/cdn-resource-options/rules-for-particular-files/create-a-rule-manually-or-from-a-template-to-configure-settings-for-particular-files" target="_blank">consult our dedicated guide</a>. | ||
|
||
## What to do if Basic WAF blocks some content that should not be blocked? | ||
|
||
If Basic WAF blocks content that you want to be allowed, you can set an exception with a rule rather than disabling the feature for the entire resource. To do so: | ||
|
||
1. In the CDN resource settings (“Rules” tab), create a rule with the URLs or regular expression of files blocked by Basic WAF. | ||
2. Add the Basic WAF option to the rule by clicking **Add option** and turn it off. | ||
|
||
<img src="https://assets.gcore.pro/docs/cdn/cdn-resource-options/cdn-security/protect-cdn-resources-with-basic-waf/basic-waf-20.png" alt="disable WAF for specific URLs via rules" width="70%"> | ||
|
||
If you need more flexible settings, use <a href="https://gcore.com/web-security" target="_blank">Web Application Security</a>. It’s a paid product that allows you to install WAF, protect it from hacking, install protection against bots and DDoS attacks, and define blacklist and whitelists. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: metadata | ||
displayName: Security | ||
displayName: Access | ||
published: true | ||
order: 30 | ||
--- |
Oops, something went wrong.