feat: release 2.1.x docs #54

tanmoysrt · 2024-06-15T09:11:24Z

Fixes #53

netlify · 2024-06-15T09:11:39Z

✅ Deploy Preview for swiftwave ready!

Name	Link
🔨 Latest commit	`7bdeb1f`
🔍 Latest deploy log	https://app.netlify.com/sites/swiftwave/deploys/666d5cfee9cb2400084d462b
😎 Deploy Preview	https://deploy-preview-54--swiftwave.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

github-actions · 2024-06-15T09:12:13Z

docs/dashboard/application_details/index.md

@@ -6,7 +6,7 @@ sidebar_position: 7

 In **Application Details**, you can see all the details about the application. You can check the status of the application, last time when it was updated, and the number of instances running for that application.

-<img src="/assets/2.0.x/application-details.png" alt="SwiftWave Dashboard" width="100%"/>
+<img src="/assets/2.1.x/application-details.png" alt="SwiftWave Dashboard" width="100%"/>


[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

github-actions · 2024-06-15T09:12:13Z

docs/dashboard/application_details/static_app_config.md

@@ -0,0 +1,26 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:12:13Z

docs/dashboard/application_details/static_app_config.md

+sidebar_position: 7
+---
+
+If your deployed application has any requirement of read-only configuration, then you can use the **Static App Config**. This will mount the static configuration file to the application and you can update it anytime from the dashboard.


[LanguageTool] _{reported by reviewdog 🐶}
Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE[1])
Suggestions: , and
URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
Category: PUNCTUATION

github-actions · 2024-06-15T09:12:13Z

docs/dashboard/ingress-rules.md

@@ -24,7 +24,7 @@ To add an ingress rule, click on **Add New** button. You will see a form like th
 You can choose the protocol your application required.
 - **HTTP**: You can choose any port for your application. It's recommended to use port 80 for HTTP.
 - **HTTPS**: Currently, only port 443 is supported.
-  > Note: To enable, **HTTPS Redirection**, you will have to create a redirect rule. You can follow [**this docs**](./redirect-rules#https-redirect) section to create a redirect rule.
+  > Note: Read this guide [**this docs**](#https-redirection) to enable  **HTTPS Redirection**.


[LanguageTool] _{reported by reviewdog 🐶}
The singular determiner ‘this’ may not agree with the plural noun ‘docs’. Did you mean “these”? (THIS_NNS[2])
Suggestions: these
Rule: https://community.languagetool.org/rule/show/THIS_NNS?lang=en-US&subId=2
Category: GRAMMAR

github-actions · 2024-06-15T09:12:13Z

docs/dashboard/ingress-rules.md

+### 🛡️ Protect Ingress Rule
+If your application is misssing authentication implementation, you can enable authentication at ingress rule level.
+
+Currently, it support only **Basic Authentication**. In future **Authelia** and **Authentik** will be supported.


[LanguageTool] _{reported by reviewdog 🐶}
After ‘it’, use the third-person verb form “supports”. (IT_VBZ[1])
Suggestions: supports
Rule: https://community.languagetool.org/rule/show/IT_VBZ?lang=en-US&subId=1
Category: GRAMMAR

github-actions · 2024-06-15T09:12:15Z

versioned_docs/version-2.1.x/cli/service/disable.md

@@ -0,0 +1,16 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:12:15Z

versioned_docs/version-2.1.x/cli/service/enable.md

@@ -0,0 +1,16 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:12:15Z

versioned_docs/version-2.1.x/cli/service/index.md

@@ -0,0 +1,16 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:12:16Z

versioned_docs/version-2.1.x/cli/service/restart.md

@@ -0,0 +1,16 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:12:16Z

versioned_docs/version-2.1.x/cli/service/status.md

@@ -0,0 +1,16 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

github-actions · 2024-06-15T09:21:52Z

versioned_docs/version-2.1.x/cli/snapshot.md

@@ -0,0 +1,26 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:21:52Z

versioned_docs/version-2.1.x/cli/snapshot.md

+
+Take snapshot of Swiftwave. Can be helpful in disaster recovery.
+
+It will backup


[LanguageTool] _{reported by reviewdog 🐶}
The word “backup” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION[1])
Suggestions: back up
Rule: https://community.languagetool.org/rule/show/NOUN_VERB_CONFUSION?lang=en-US&subId=1
Category: GRAMMAR

github-actions · 2024-06-15T09:21:52Z

versioned_docs/version-2.1.x/cli/start.md

@@ -0,0 +1,18 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:21:52Z

versioned_docs/version-2.1.x/cli/tls/disable.md

@@ -0,0 +1,17 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:21:53Z

versioned_docs/version-2.1.x/cli/tls/enable.md

@@ -0,0 +1,16 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:21:55Z

versioned_docs/version-2.1.x/dashboard/application_details/application_update_source.md

@@ -0,0 +1,16 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:21:55Z

versioned_docs/version-2.1.x/dashboard/application_details/application_update_source.md

+- Change anything you want.
+- Click on **`Apply Changes`** button to update the source of the application.
+
+> 📌 Note: If you have deployed your application using git, currently you can't switch to docker image deployment or something else. In future, we will try to support this feature.


[LanguageTool] _{reported by reviewdog 🐶}
The phrase ‘In future’ is British English. Did you mean: “In the future”? (IN_FUTURE[1])
Suggestions: In the future
URL: https://www.merriam-webster.com/dictionary/in%20future
Rule: https://community.languagetool.org/rule/show/IN_FUTURE?lang=en-US&subId=1
Category: BRITISH_ENGLISH

github-actions · 2024-06-15T09:21:55Z

versioned_docs/version-2.1.x/dashboard/application_details/deployment_configuration.md

@@ -0,0 +1,30 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

github-actions · 2024-06-15T09:21:55Z

versioned_docs/version-2.1.x/dashboard/application_details/deployment_configuration.md

+- **Global Mode** - In this mode, each server registered under swiftwave will run one instance of the application.
+
+:::note
+


[LanguageTool] _{reported by reviewdog 🐶}
A comma may be missing after the conjunctive/linking adverb ‘Currently’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[1])
Suggestions: Currently,
URL: https://languagetool.org/insights/post/linking-words/
Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=1
Category: PUNCTUATION

github-actions · 2024-06-15T09:21:55Z

versioned_docs/version-2.1.x/dashboard/application_details/deployments.md

@@ -0,0 +1,25 @@
+---


[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

feat: release 2.1.x docs

c27d1eb

github-actions bot reviewed Jun 15, 2024

View reviewed changes

fix: link

7bdeb1f

github-actions bot reviewed Jun 15, 2024

View reviewed changes

tanmoysrt merged commit d9ebf27 into main Jun 15, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: release 2.1.x docs #54

feat: release 2.1.x docs #54

tanmoysrt commented Jun 15, 2024

netlify bot commented Jun 15, 2024 •

edited

Loading

github-actions bot left a comment

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot left a comment

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024

github-actions bot Jun 15, 2024


		Take snapshot of Swiftwave. Can be helpful in disaster recovery.

		It will backup

		- Global Mode - In this mode, each server registered under swiftwave will run one instance of the application.

		:::note

feat: release 2.1.x docs #54

feat: release 2.1.x docs #54

Conversation

tanmoysrt commented Jun 15, 2024

netlify bot commented Jun 15, 2024 • edited Loading

✅ Deploy Preview for swiftwave ready!

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

github-actions bot Jun 15, 2024

Choose a reason for hiding this comment

netlify bot commented Jun 15, 2024 •

edited

Loading