Skip to content

Commit 6ea3bad

Browse files
committed
doc: Corrected StackGres camel case
1 parent d8cdef7 commit 6ea3bad

8 files changed

Lines changed: 13 additions & 13 deletions

File tree

  • doc/content/en
    • 04-administration-guide
    • 07-developer-documentation/06-contributing-guide

doc/content/en/04-administration-guide/01-stackgres-installation/03-installation-via-operatorhub/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Remember to remove the generated password hint from the secret to avoid security
111111
kubectl patch secret --namespace stackgres stackgres-restapi-admin --type json -p '[{"op":"remove","path":"/data/clearPassword"}]'
112112
```
113113

114-
Modify the configuration by patching the stackgres SGConfig
114+
Modify the configuration by patching the StackGres SGConfig
115115

116116
```
117117
cat << EOF | kubectl patch -n openshift-operators sgconfig stackgres --type merge -p "$(cat)"
@@ -173,7 +173,7 @@ To watch the operator installation you may look at Pods in the `openshift-operat
173173
kubectl get pod -n openshift-operators --watch
174174
```
175175

176-
Modify the configuration by patching the stackgres SGConfig:
176+
Modify the configuration by patching the StackGres SGConfig:
177177

178178
```
179179
cat << EOF | kubectl patch -n openshift-operators sgconfig stackgres --type merge -p "$(cat)"

doc/content/en/04-administration-guide/02-connecting-to-the-cluster/01-passwords/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ showToc: true
1010
When creating a cluster, StackGres randomly generates passwords, for the `postgres` superuser and others.
1111
The passwords are stored in a secret (named as the cluster).
1212

13-
By default, a Stackgres cluster initialization creates 3 users:
13+
By default, a StackGres cluster initialization creates 3 users:
1414

1515
- `superuser`
1616
- `replication`
1717
- `authenticator`
1818

1919
The passwords are stored in that secret under the keys `<user>-password`.
2020

21-
Assuming that we have a Stackgres cluster named `cluster`, we can get the passwords with the following commands:
21+
Assuming that we have a StackGres cluster named `cluster`, we can get the passwords with the following commands:
2222

2323
- **superuser / postgres:**
2424

doc/content/en/04-administration-guide/05-backups/04-oke/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Create the required permissions and the user with following characteristics (tha
2323
Create the `stackgres-demo-k8s-user` user:
2424

2525
```
26-
oci iam user create --name stackgres-demo-k8s-user --description 'Stackgres backup user'
26+
oci iam user create --name stackgres-demo-k8s-user --description 'StackGres backup user'
2727
```
2828

2929
Create the group that the user will be a part of, which will have access to the bucket:
3030

3131
```
32-
oci iam group create --name stackgres-backup-group --description 'Stackgres backup group'
32+
oci iam group create --name stackgres-backup-group --description 'StackGres backup group'
3333
```
3434

3535
Add the user to the group:
@@ -61,7 +61,7 @@ Create a policy to allow the created group to use the bucket:
6161
oci iam policy create \
6262
--compartment-id $s3compartment_id \
6363
--name stackfres-backup-policy \
64-
--description 'Policy to use the bucket for Stackgres backups' \
64+
--description 'Policy to use the bucket for StackGres backups' \
6565
--statements '["Allow group stackgres-backup-group to use bucket on compartment id '$s3compartment_id' where target.bucket.name = '/''backup-demo-of-stackgres-io'/''"]'
6666
```
6767

doc/content/en/04-administration-guide/10-replication/03-remote-cluster/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: This section explains how to setup external replication for a clust
66
showToc: true
77
---
88

9-
Having a Postgres server replica outside the main 'DC|Zone|Geografic Area' is the next level of High Avaliability. DBA teams already know stories of companies losing the entire DC because of different physical issues and even more, when working with k8s and having many cloud providers a door is open to the options of setting up Stackgres across k8s platform services and migrating from one to other without any vendor restriction. Therefore, Stackgres already added the support to create external cluster replicas.
9+
Having a Postgres server replica outside the main 'DC|Zone|Geografic Area' is the next level of High Avaliability. DBA teams already know stories of companies losing the entire DC because of different physical issues and even more, when working with k8s and having many cloud providers a door is open to the options of setting up StackGres across k8s platform services and migrating from one to other without any vendor restriction. Therefore, StackGres already added the support to create external cluster replicas.
1010

1111
Lets do it!
1212

doc/content/en/04-administration-guide/10-replication/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ aliases: [ /tutorial/admin/replication ]
66
description: This page contains details about how to create different cluster arquitecture topologies by using the replication features.
77
---
88

9-
Stackgres supports all Postgres and Patroni features to set the different replication options that come with these technologies. Indeed, Stackgres don't use any custom owned replication mechanism or protocol, it fully relies upon the official Postgres replication development. Furthermore, Stackgres relies upon the Patroni HA development, therefore, failOver, switchOver, and replication should work as any other Postgres cluster.
9+
StackGres supports all Postgres and Patroni features to set the different replication options that come with these technologies. Indeed, StackGres don't use any custom owned replication mechanism or protocol, it fully relies upon the official Postgres replication development. Furthermore, StackGres relies upon the Patroni HA development, therefore, failOver, switchOver, and replication should work as any other Postgres cluster.
1010

1111
{{% children style="li" depth="1" description="true" %}}

doc/content/en/04-administration-guide/14-sharded-cluster/13-connecting-to-the-sharded-cluster/01-passwords/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ showToc: true
99
When creating a sharded cluster, StackGres randomly generates passwords, for the `postgres` superuser and others.
1010
The passwords are stored in a secret (named as the sharded cluster).
1111

12-
By default, a Stackgres sharded cluster initialization creates 3 users:
12+
By default, a StackGres sharded cluster initialization creates 3 users:
1313

1414
- `superuser`
1515
- `replication`
1616
- `authenticator`
1717

1818
The passwords are stored in that secret under the keys `<user>-password`.
1919

20-
Assuming that we have a Stackgres sharded cluster named `cluster`, we can get the passwords with the following commands:
20+
Assuming that we have a StackGres sharded cluster named `cluster`, we can get the passwords with the following commands:
2121

2222
- **superuser / postgres:**
2323

doc/content/en/07-developer-documentation/06-contributing-guide/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Please observe the following rules when contributing to StackGres:
1212

1313
* [Create an issue](https://gitlab.com/ongresinc/stackgres/issues/new) with any question or improvements about the source code, to keep the discussion organized.
1414

15-
* Contact us at stackgres at ongres dot com before sending a merge request, to have a contributor agreement signed with us.
15+
* Contact us at StackGres at Ongres dot com before sending a merge request, to have a contributor agreement signed with us.
1616
This is a requirement for your merge request to be merged upstream.
1717

1818
* Changes and merge requests should be performed from the `development` branch, instead of `main`.

doc/content/en/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ StackGres source code is licensed under the [OSI](https://opensource.org/license
1616

1717
## Is there a “GPL-free” commercial license for StackGres?
1818

19-
Yes. Contact us at stackgres at ongres doc com if you want a trial or commercial license that does not contain the GPL clauses.
19+
Yes. Contact us at StackGres at Ongres doc com if you want a trial or commercial license that does not contain the GPL clauses.
2020

2121
## Will you ever switch from an open-source license to a source-available one?
2222

0 commit comments

Comments
 (0)