Skip to content

Commit

Permalink
Merge pull request #5690 from EnterpriseDB/style-guide-terms
Browse files Browse the repository at this point in the history
Added style guide information for three new topics
  • Loading branch information
gvasquezvargas authored May 31, 2024
2 parents b4b3901 + aaac8ab commit 8b5905f
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions advocacy_docs/community/contributing/styleguide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ Included in this guide:
* 11 [Lists](#lists)
* 12 [Images](#images)
* 13 [Dates](#dates)
* 14 [Terminology considerations](#terminology-considerations)
* 15 [Trademark symbols](#trademark-symbols)

## Language and tone

Expand Down Expand Up @@ -594,3 +596,38 @@ When specifying dates for human readability, use the DD mmm YYYY format with a s
When specifying dates as solely numbers, use [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format; YYYY/MM/DD. This is the internationally accepted, disambiguous format and should be used where you may expect the date to be read by automated systems.
## Terminology considerations
### Ambiguity of the term "cluster"
The term "cluster" can refer to different groups of resources in the technological field.
At EDB, the product documentation uses the term "cluster" to refer to several different objects/concepts.
To avoid ambiguity, always use an adjective (describing word) to clarify which of the cluster types you're referring to in the specific context.
Here are a few examples:
**Postgres cluster**: Also known as a [database cluster](/epas/latest/fundamentals/epas_fundamentals/terminology/#database-cluster), a Postgres cluster is a Postgres server that hosts a number of databases in a single file system location.
**PGD cluster**: A [PGD cluster](/pgd/latest/terminology/#pgd-cluster) is a [Postgres Distributed](/pgd/latest/) system with a group of multiple redundant database systems in different locations.
**Kubernetes cluster**: A [Kubernetes cluster](https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-cluster) is a set of multiple nodes that run containerized applications.
### Postgres distributions
EDB products support three types of Postgres distributions:
- PostgreSQL (open-source or community Postgres)
- EDB Postgres Advanced Server (EPAS)
- EDB Postgres Extended Server (PGE)
Although also referred to as "Postgres flavors," the preferred terms are "Postgres" or "Postgres distributions" to refer to all three options.
## Trademark symbols
Use the ™ or ® symbol at least upon the first use of the `EDB Postgres® + [product]` trademark in the body text of a page.
Examples: EDB Postgres® AI, EDB Postgres® Analytics, EDB Postgres® Machine Learning, etc.
For other trademarks, the documentation site already includes a general disclaimer at the footer of every page called "Trademark" which links to https://www.enterprisedb.com/trademarks.
Contrary to the specifications on [Trademarks](https://www.enterprisedb.com/trademarks), don't include the symbol in page titles,
because the symbol can affect how search engines index and find pages.

1 comment on commit 8b5905f

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.