Skip to content

Commit 1e04f9c

Browse files
Merge branch 'main' into 3803-update-premium-service-pages
2 parents 38db891 + ad0285a commit 1e04f9c

File tree

4 files changed

+64
-24
lines changed

4 files changed

+64
-24
lines changed

contributing/content-style.md

+35-19
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
Thank you for your interest in contributing to the Platform.sh docs!
44
It's nice to share the goal of having clear and up-to-date documentation.
55

6-
This content style guide should help make sure the Platform.sh docs are clear and consistent.
7-
It's intended for use by all contributors,
8-
from Platform.sh engineers to people from the community.
6+
This content style guide should help make sure the Platform.sh docs are clear and consistent. It's intended for use by all contributors,from Platform.sh engineers to people from the community.
97

108
<!-- vale Platform.condescending = NO -->
119
## Table of contents
@@ -39,12 +37,11 @@ from Platform.sh engineers to people from the community.
3937

4038
## About the audience
4139

42-
The goal of Platform.sh's documentation is to help tech-savvy users self-educate
43-
on how to use and get the most out of Platform.sh.
44-
Readers are generally familiar with common web development tools and practices
45-
(such as Git, branching, web servers, and databases),
46-
but not necessarily with server administration.
47-
Make sure to provide enough context, potentially by linking to existing resources elsewhere.
40+
The goal of Platform.sh and Upsun's documentation is to help tech-savvy users self-educate on how to use and get the most out of Platform.sh.
41+
42+
Readers are generally familiar with common web development tools and practices, but it's best not to assume an in-depth knowledge of processes related to Upsun or Platform.sh. Remember, our audience may be comprised of more than developers, so try to explain concepts as simply as possible.
43+
44+
Make sure to provide enough context, potentially by linking to existing resources elsewhere. Try to include as many examples as you sit fit to demonstrate the process you're taking the user through.
4845

4946
## Style defaults
5047

@@ -56,17 +53,15 @@ For a quick summary of that guide, see the [Google style guide highlights](https
5653
Platform.sh docs should be in standard U.S. spelling,
5754
with reference to the [Merriam-Webster dictionary](https://www.merriam-webster.com/).
5855

59-
The name of the company is always written as "Platform.sh", not only "Platform".
60-
It shouldn't be used as a link.
56+
The name of the company is always written as "Platform.sh" or "Upsun", not only "Platform".
6157

6258
## Address the reader directly
6359

64-
In keeping with the Platform.sh value that to "tell it like it is",
60+
In keeping with the Platform.sh value that is to "tell it like it is",
6561
focus texts on readers and talk to them directly.
6662

6763
This means using the second person ("you") and telling them what to do.
68-
Unless you have a very good reason (such as an action that has to be done by Platform.sh manually),
69-
avoid the first person ("we", "us", and "our").
64+
Unless you have a very good reason (such as an action that has to be done by Platform.sh manually), avoid the first person ("we", "us", and "our").
7065

7166
Use | Avoid
7267
-------------------------------------------------|-------
@@ -78,7 +73,14 @@ Part of this directness is also avoiding using `please`.
7873
Only use `please` if you're asking for something that benefits Platform.sh
7974
or inconveniences the reader.
8075

81-
So it's OK in phrases like `If you get an error, please open a support ticket.`
76+
So it's okay in phrases like `If you get an error, please open a support ticket.`
77+
78+
{{< note theme="info" title="Using first person in articles" >}}
79+
It should be noted that the first person plural ("we", "us", and "our") can be used in articles on DevCenter. The style of this content is more conversational in tone, and suits the use of the collective first person when guiding the user through a process.
80+
For example, the sentences below are acceptable for articles:
81+
- 'Our content will be loaded directly in the assistant on OpenAI.'
82+
- 'Now that our Chainlit application is deployed and available, it would be great to add some form of authentication to make sure only you and your folks can access it.'
83+
{{< /note >}}
8284

8385
## Aim for neutral text
8486

@@ -91,6 +93,12 @@ Use | Avoid
9193
Be careful not to break anything | Of course, you naturally have to avoid breaking anything
9294
Making this small change can have large effects | Surprisingly, making this tiny change can have huge effects
9395

96+
{{< note theme="info" title="Using neutral text in articles" >}}
97+
98+
It should be noted that the technical articles on DevCenter are allowed less neutrality than the documentation, as this content is naturally more conversational in tone.
99+
100+
{{< /note >}}
101+
94102
## Use inclusive language
95103

96104
In keeping with the Platform.sh value of being diverse,
@@ -119,7 +127,6 @@ To make your content as accessible as possible, the purpose of a link should be
119127
Avoid links with text like `click here`
120128
and instead try to include meaning inside the link itself.
121129

122-
Remember to use the [proper format for links](./markup-format.md#links)
123130

124131
The supporting documentation for the Web Content Accessibility Guidelines
125132
explains [why link purpose in the text alone is good](https://www.w3.org/WAI/WCAG21/Understanding/link-purpose-link-only).
@@ -128,10 +135,19 @@ Use | Avoid
128135
-----------------------------------------------------------|-------
129136
Read more information [about images](https://example.com) | For more info on images, [click here](https://example.com)
130137

138+
### Use root format for links
139+
140+
Always define links from the root of the `sites/upsun/src` folder.
141+
142+
Use | Avoid
143+
-----------------------------------------------------------|-------
144+
'/development/variables/set-variables.md#set-variables-via-script' | './set-variables.md#set-variables-in-your-app'
145+
146+
Formatting our links this way allows for our content to easily be converted to markdown. It also allows our content to be easily interpreted by any large language models that might be used. This is a way of ensuring our content remains AI-friendly.
147+
131148
### Link at the end of sentences in sentence case
132149

133-
Readers often scan through text looking for links and other important information.
134-
Having links in the middle of sentences can make them harder to parse.
150+
Readers often scan through text looking for links and other important information. Having links in the middle of sentences can make them harder to parse.
135151

136152
Put links at the end of sentences and keep them in sentence case.
137153

@@ -205,7 +221,7 @@ By avoiding overly wordy phrases, you help make it clearer what needs to be done
205221

206222
For example, try to avoid using sentences starting with `There is/are` or `It is` too often.
207223
While there are times when this makes sense, often you can rephrase the sentence to be more direct.
208-
Such phrases work well for rhythm and emphasis, but that is usually less important in technical writing.
224+
Such phrases work well for rhythm and emphasis, but that is usually less important in technical writing for both documentation and technical blogs or articles.
209225

210226
Similar arguments apply to passive sentences.
211227
Sometimes, they work well, such as when the subject would be `the system`

sites/platform/src/add-services/postgresql.md

+12
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,18 @@ Taking a backup or a database export before doing so is strongly recommended.
365365
To ensure people who review code changes can't access personally identifiable information stored in your database,
366366
[sanitize your preview environments](../development/sanitize-db/postgresql.md).
367367

368+
## Set locale for database
369+
370+
You can choose your locale when a database is created by setting locale-related variables. There are three ways to set a locale option, as detailed in the table below:
371+
372+
373+
| Name | Type | Default | Description |
374+
|--------|-----------|----------|--------------|
375+
| `default_ctype` | `string` | `C.UTF-8` | The default character classification. Affects any tables created after it's set.|
376+
| `default_collation` | `string`|`C.UTF-8`| The default collation rules. Affects any tables created after it's set.|
377+
| `default_charset` | `string` | `UTF8` | The default encoding character set. Affects any tables created after it's set.|
378+
379+
368380
## Multiple databases
369381

370382
If you are using version `10`, `11`, `12`, `13`, or later of this service,

sites/platform/src/administration/users.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ An environment type (Production, Staging, and Development) groups one or more en
3636

3737
A user can have one of the following roles on an environment type which grants them permissions on all environments of this type:
3838

39-
| Role | View environment | Push code | Branch environment | SSH access | Change settings | Execute actions |
40-
|-------------|------------------|-----------|--------------------|------------|-----------------|-----------------|
41-
| Admin | Yes | Yes | Yes | Yes | Yes | Yes |
42-
| Contributor | Yes | Yes | Yes | Yes | No | No |
43-
| Viewer | Yes | No | Yes | No | No | No |
39+
| Role | View environment | Force push | Push code | Branch environment | SSH access | Change settings | Execute actions |
40+
|-------------|------------------|------------|-----------|--------------------|------------|-----------------|-----------------|
41+
| Admin | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
42+
| Contributor | Yes | No | Yes | Yes | Yes | No | No |
43+
| Viewer | Yes | No | No | Yes | No | No | No |
4444

4545
To customize which roles can use SSH, set [`access` in your app configuration](/create-apps/app-reference/single-runtime-image.md#access).
4646

sites/upsun/src/add-services/postgresql.md

+12
Original file line numberDiff line numberDiff line change
@@ -483,6 +483,18 @@ Taking a backup or a database export before doing so is strongly recommended.
483483
To ensure people who review code changes can't access personally identifiable information stored in your database,
484484
[sanitize your preview environments](../development/sanitize-db/postgresql.md).
485485

486+
## Set locale for database
487+
488+
You can choose your locale when a database is created by setting locale-related variables. There are three ways to set a locale option, as detailed in the table below:
489+
490+
491+
| Name | Type | Default | Description |
492+
|--------|-----------|----------|--------------|
493+
| `default_ctype` | `string` | `C.UTF-8` | The default character classification. Affects any tables created after it's set.|
494+
| `default_collation` | `string`|`C.UTF-8`| The default collation rules. Affects any tables created after it's set.|
495+
| `default_charset` | `string` | `UTF8` | The default encoding character set. Affects any tables created after it's set.|
496+
497+
486498
## Multiple databases
487499

488500
If you are using version `10`, `11`, `12`, `13`, or later of this service,

0 commit comments

Comments
 (0)