Merge pull request #540 from G-Core/14-november-edge

was asked by Vasilyi to publish the article
G-Core · Nov 14, 2023 · c430f49 · c430f49
2 parents d2bb62f + 81664ca
commit c430f49
Show file tree

Hide file tree

Showing 3 changed files with 112 additions and 11 deletions.
diff --git a/documentation/account-settings/propose-changes-to-articles-on-github.md b/documentation/account-settings/propose-changes-to-articles-on-github.md
@@ -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.
+
+5\. 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>
diff --git a/...mentation/cdn/cdn-resource-options/general/use-a-private-bucket-as-an-origin.md b/...mentation/cdn/cdn-resource-options/general/use-a-private-bucket-as-an-origin.md
@@ -55,14 +55,6 @@ To configure a private origin:
 
 A new page will open. Complete the remaining steps of the manual in the "Origin" section on this page.
 
-In the example below, we use the private bucket ```test-private``` in S3 Gcore storage with the endpoint (service URL) ```s-ed1.cloud.gcore.lu```. 
-
-**Note**: To determine the endpoint (service URL) of your S3 storage, use the <a href="https://gcore.com/docs/storage/manage-s3-storage/s3-service-urls-and-default-region-names" target="_blank">S3 service URLs and default region names</a> guide.
-
-Configure an origin group as follows:
-
-<img src="https://assets.gcore.pro/docs/cdn/cdn-resource-options/general/use-a-private-bucket-as-an-origin/private-bucket-conf.png" alt="Origin section" width="80%">
-
 2\. Select the **Specify content origin** option.
 
 3\. Select **AWS signature V4** in the "Type of origin authentication" field.
@@ -74,11 +66,18 @@ Configure an origin group as follows:
   - **For Amazon storage**: Access Key ID, Secret access key, and AWS region
   - **For Other**: Hostname (there's a bucket at the beginning), Access Key ID, Secret access key, and Region
 
+**Note**: To determine the region of your Gcore S3 storage, use the <a href="https://gcore.com/docs/storage/manage-s3-storage/s3-service-urls-and-default-region-names" target="_blank">S3 service URLs and default region names</a> guide.
+
 More information about where to find the keys can be found in the "<a href="https://gcore.com/docs/storage/create-an-s3-or-sftp-storage" target="_blank">Authentication data</a>" section.
 
 6\. Enter the **Bucket name**.
 
-7\. Continue the CDN resource creation according to the "<a href="https://gcore.com/docs/cdn/getting-started/create-a-cdn-resource/create-a-cdn-resource-for-only-static-files" target="_blank">Create CDN resource for only static files</a>" guide (steps #3–6).
+In the example below, we use the private bucket ```test-private``` in S3 Gcore storage with the endpoint (service URL) ```s-ed1.cloud.gcore.lu```. Configure an origin group as follows:
+
+<img src="https://assets.gcore.pro/docs/cdn/cdn-resource-options/general/use-a-private-bucket-as-an-origin/private-bucket-conf.png" alt="Origin section" width="70%">
+
+
+7\. Continue the CDN resource creation according to the "<a href="https://gcore.com/docs/cdn/getting-started/create-a-cdn-resource/create-a-cdn-resource-for-only-static-files" target="_blank">Create CDN resource for only static files</a>" guide.
 
 8\. Go to the resource settings and open the Host header option in the "HTTP headers" section. Specify the URL of your storage Hostname (the URL depends on your S3 provider) in the following format: 
 

diff --git a/documentation/edit-article-guide.md b/documentation/edit-article-guide.md
@@ -93,5 +93,4 @@ If you found an error in the text and do not want to correct it yourself, follow
 
 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>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -93,5 +93,4 @@ If you found an error in the text and do not want to correct it yourself, follow

		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>