Merge pull request #488 from G-Core/WEB-5704-edit-github

Web 5704 edit GitHub

documentation/edit-article-guide.md

@@ -1,6 +1,91 @@
 ---
-title: edit-article
-displayName: If you need help in proposing changes on GitHub, use the guide below:
+title: edit-article-guide
+displayName: Edit article guide
 published: true
 ---
+<edit-github-button></edit-github-button>
+
 ### If you need help in proposing changes on GitHub, use the guide below:
+
+1\. <a href="https://github.com/login" target="_blank">Sign in</a> to your GitHub account.
+
+2\. (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.
+
+3\. Select the appropriate action from the options below, and follow the instructions.
+
+<img src="https://assets.gcore.pro/docs/edit-article-guide/propose-changes-10.png" alt="Fork this repository function on GitHub" width="80%">
+
+<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>&lt;a href="https://wrong-link"&gt;</code> attribute. Insert the correct <code>&lt;a href="https://right-link"&gt;</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>
+

scully/plugins/move-content-files/move-content-files.ts

@@ -22,6 +22,7 @@ const defaultOptions: Required<MoveContentFilesPluginOptions> = {
         'ddos-protection',
         'web-security',
         'reseller-support',
+        'edit-article-guide',
     ],
 };
 const sitemap = 'sitemap.xml';