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.

Sign up for GitHub

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

DEV FAQ entry + MongoDB clean + partial #484

Merged
merged 5 commits into from
Jan 7, 2025
+13 −9
Merged

DEV FAQ entry + MongoDB clean + partial #484

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8495c29
DEV FAQ entry + MongoDB clean + partial
PLhuillery Jan 3, 2025
22066bf
Update content/doc/find-help/faq.md
PLhuillery Jan 6, 2025
6777ca9
Update content/doc/find-help/faq.md
PLhuillery Jan 7, 2025
6cc1f4e
Apply suggestions from code review
cnivolle Jan 7, 2025
39ea2dc
Merge branch 'main' into harmonizing_free_plans_info
cnivolle Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions content/doc/addons/mongodb/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,15 @@

### Higher Versions

If you puchased a higher version from MongoDB and you want to deploy your database on Clever Cloud, please [contact us](https://www.clever-cloud.com/contact/).

## About Free Databases

Free plans are recommended for test and development usage only. Using these databases in production is not recommended, because performance may vary depending on the global usage of the cluster. Therefore, before switching to production, consider upgrading to a dedicated database for better performance.
If you purchased a higher version from MongoDB and you want to deploy your database on Clever Cloud, please [contact us](https://www.clever-cloud.com/contact/).

Check warning on line 33 in content/doc/addons/mongodb/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/mongodb/_index.md#L33 

[Google.We] Try to avoid using first-person plural like 'us'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'us'.", "location": {"path": "content/doc/addons/mongodb/_index.md", "range": {"start": {"line": 33, "column": 118}}}, "severity": "WARNING"}
cnivolle marked this conversation as resolved.
Show resolved Hide resolved

{{< callout type="warning" >}}
The ability to create free plan for MongoDB is currently turned off. It may come back in the future.
DEV plan is no longer available for MongoDB.

Check notice on line 36 in content/doc/addons/mongodb/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/mongodb/_index.md#L36 

[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.", "location": {"path": "content/doc/addons/mongodb/_index.md", "range": {"start": {"line": 36, "column": 1}}}, "severity": "INFO"}
{{< /callout >}}

### Important Note About Fair Use on Free Databases
### Important Note About Fair Use on DEV plans

Check notice on line 39 in content/doc/addons/mongodb/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/mongodb/_index.md#L39 

[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.", "location": {"path": "content/doc/addons/mongodb/_index.md", "range": {"start": {"line": 39, "column": 38}}}, "severity": "INFO"}
PLhuillery marked this conversation as resolved.
Show resolved Hide resolved
cnivolle marked this conversation as resolved.
Show resolved Hide resolved

Heavy usage of free databases may impact the shared cluster they rely upon. It will degrade performance of the other databases. To that extent, we set a soft limit of **15 operations/second**. Going above the limit will expose your database to disconnection, would you not answer our notices.
Heavy usage of DEV databases may impact the shared cluster they rely upon. It will degrade performance of the other databases. To that extent, DEV plan has a limit of **15 operations/second**. Going above the limit might disconnect your database.

Check notice on line 41 in content/doc/addons/mongodb/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/mongodb/_index.md#L41 

[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.", "location": {"path": "content/doc/addons/mongodb/_index.md", "range": {"start": {"line": 41, "column": 16}}}, "severity": "INFO"}

Check warning on line 41 in content/doc/addons/mongodb/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/mongodb/_index.md#L41 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "content/doc/addons/mongodb/_index.md", "range": {"start": {"line": 41, "column": 79}}}, "severity": "WARNING"}

Check notice on line 41 in content/doc/addons/mongodb/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/mongodb/_index.md#L41 

[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.", "location": {"path": "content/doc/addons/mongodb/_index.md", "range": {"start": {"line": 41, "column": 144}}}, "severity": "INFO"}

Check warning on line 41 in content/doc/addons/mongodb/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/addons/mongodb/_index.md#L41 

[Google.WordList] Use 'preceding' instead of 'above'.
Raw output 
{"message": "[Google.WordList] Use 'preceding' instead of 'above'.", "location": {"path": "content/doc/addons/mongodb/_index.md", "range": {"start": {"line": 41, "column": 200}}}, "severity": "WARNING"}

{{% content/db-backup %}}

Expand Down
9 changes: 9 additions & 0 deletions content/doc/find-help/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,3 +229,12 @@

To create add-ons, you need to complete your account information, including your city and ZIP code.
For instance, you cannot create a Matomo add-on until you provide these details.

## What is a DEV plan ?

Check notice on line 233 in content/doc/find-help/faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/find-help/faq.md#L233 

[Google.Contractions] Use 'what's' instead of 'What is'.
Raw output 
{"message": "[Google.Contractions] Use 'what's' instead of 'What is'.", "location": {"path": "content/doc/find-help/faq.md", "range": {"start": {"line": 233, "column": 4}}}, "severity": "INFO"}

Check notice on line 233 in content/doc/find-help/faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/find-help/faq.md#L233 

[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.", "location": {"path": "content/doc/find-help/faq.md", "range": {"start": {"line": 233, "column": 14}}}, "severity": "INFO"}

DEV plan is a free-tier plan available for some databases, designed to let customers explore and test these products.

Check notice on line 235 in content/doc/find-help/faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/find-help/faq.md#L235 

[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.", "location": {"path": "content/doc/find-help/faq.md", "range": {"start": {"line": 235, "column": 1}}}, "severity": "INFO"}
While these plans are cost-free, they operate on shared clusters, which may result in variable performance; they also have no SLA guarantees.

Check notice on line 236 in content/doc/find-help/faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/find-help/faq.md#L236 

[Google.Passive] In general, use active voice instead of passive voice ('are cost').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are cost').", "location": {"path": "content/doc/find-help/faq.md", "range": {"start": {"line": 236, "column": 19}}}, "severity": "INFO"}

Check notice on line 236 in content/doc/find-help/faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/find-help/faq.md#L236 

[Google.Semicolons] Use semicolons judiciously.
Raw output 
{"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "content/doc/find-help/faq.md", "range": {"start": {"line": 236, "column": 107}}}, "severity": "INFO"}

Check notice on line 236 in content/doc/find-help/faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/find-help/faq.md#L236 

[Google.Acronyms] Spell out 'SLA', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'SLA', if it's unfamiliar to the audience.", "location": {"path": "content/doc/find-help/faq.md", "range": {"start": {"line": 236, "column": 127}}}, "severity": "INFO"}
PLhuillery marked this conversation as resolved.
Show resolved Hide resolved

Some features such as simultaneous connections numbers, functions...might be reduced or unavailable.

Check notice on line 238 in content/doc/find-help/faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/find-help/faq.md#L238 

[Google.Passive] In general, use active voice instead of passive voice ('be reduced').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be reduced').", "location": {"path": "content/doc/find-help/faq.md", "range": {"start": {"line": 238, "column": 75}}}, "severity": "INFO"}
PLhuillery marked this conversation as resolved.
Show resolved Hide resolved

Support is not able to provide help in case of DEV plan.

Check notice on line 240 in content/doc/find-help/faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/find-help/faq.md#L240 

[Google.Contractions] Use 'isn't' instead of 'is not'.
Raw output 
{"message": "[Google.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "content/doc/find-help/faq.md", "range": {"start": {"line": 240, "column": 9}}}, "severity": "INFO"}

Check notice on line 240 in content/doc/find-help/faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/find-help/faq.md#L240 

[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'DEV', if it's unfamiliar to the audience.", "location": {"path": "content/doc/find-help/faq.md", "range": {"start": {"line": 240, "column": 48}}}, "severity": "INFO"}
2 changes: 1 addition & 1 deletion layouts/shortcodes/software_versions_shared_dedicated.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@
</tbody>
</table>
{{ if $has_dev }}
{{ $.Page.RenderString "<!-- markdown -->{{< callout type=\"warning\">}} <strong>Important</strong>: Dev plans are free and <u>solely for testing purposes</u>. They don't provide the same guarantees or SLAs as dedicated plans. {{< /callout >}}" | safeHTML }}
{{ $.Page.RenderString "<!-- markdown -->{{< callout type=\"warning\">}} <strong>Important</strong>: Dev plan is free but <u>for testing purposes</u>. It has lower performances and no SLA. You can find more info [here](/doc/find-help/faq.md) {{< /callout >}}" | safeHTML }}
cnivolle marked this conversation as resolved.
Show resolved Hide resolved
{{ end }}

Loading