Documentation terminology
Apply the naming rules: the four platform terms, the official Platform Resource names, and the terms that stay in US English.
Use the official names
Every offering has one official name, and every page uses that name. The names come from Azion’s official naming catalog, which Product Marketing maintains for all Azion content: documentation, the website, and sales material. The Overview page of each Platform Resource, the root of its section, reflects that catalog. This guide does not restate the current names, because a copy is wrong the day a name changes.
The catalog gives one name per offering. There is no separate marketing name and documentation name. The first mention can carry the full name with the abbreviation in parentheses, and every mention after it uses the abbreviation alone:
- Correct:
Web Application Firewall (WAF) inspects HTTP and HTTPS requests. Apply a WAF rule set to the firewall. - Incorrect: a second
Web Application Firewall (WAF)on the same page.
Name the platform Azion Platform, or Azion Web Platform where the context calls for it. Never write Azion Edge Platform. In a possessive, the platform is a common noun, in lowercase: Azion's platform, never Azion's Platform.
Keep deprecated names out of current pages
Azion renamed its offerings over time. The old names still appear in old pages, URLs, and directory names, so they can look current. Treat them as history, not as synonyms. A deprecated name does not change again, so this list does not go out of date the way a list of current names does:
| Deprecated | Current |
|---|---|
| Edge Application | Applications |
| Edge Firewall | Firewall |
| Edge Connector | Connectors |
| Real-Time Manager | Console |
| Edge AI | AI Inference |
| Application Acceleration | Application Accelerator |
| Edge Cache | Cache |
| Edge Functions | Functions |
| Image Processing | Image Processor |
| Edge Orchestrator | Orchestrator |
| Edge KV | KV Store |
| Edge Storage | Object Storage |
| Edge SQL | SQL Database |
| Network Layer Protection | Network Shield |
| Data Streaming | Data Stream |
| Azion Edge Platform | Azion Platform |
Edge DNS and Edge Pulse are current official names. The word Edge in them is not a sign of a deprecated name.
Name the resource the reader works on
Azion describes what it offers with four terms. They are related concepts, not four levels of one hierarchy: a Platform Resource may or may not be a Product, and a Feature can belong to the Platform or to a Platform Resource.
| Term | Answers | Definition |
|---|---|---|
| Platform | What is the integrated Azion experience? | Azion’s distributed infrastructure, its integrated technology, and the interfaces to build, secure, and scale workloads, such as Console, the API, and the CLI |
| Product | What offering does Azion take to market? | A market offering made of one or more Platform Resources and Features that solves a customer problem, such as WAF or Object Storage |
| Platform Resource | What does the reader create or manage? | An identifiable entity that the customer creates, configures, operates, or manages, and that Console, the API, the CLI, or the documentation can reference, such as an Application, a Firewall, a Function, or a bucket |
| Feature | What can the reader do or turn on? | A user-visible functionality of the Platform or of a Platform Resource, which a Product can include, such as custom firewall rules or DNSSEC |
Documentation uses the Platform Resource nomenclature. Product is a go-to-market term, used mainly in marketing and sales material, and the table defines it so the reader recognizes it there. A documentation page calls each section by its official name and calls the offering a Platform Resource, never a product: it names what the reader creates or manages, and it joins one Platform Resource to another with a verb. Product never classifies an element on a page, per State the class of an Azion element.
A Feature is always scoped, so state whether it applies to the Platform or to a Platform Resource. A field or an option on a Platform Resource is a setting, not a Feature.
Applications, Firewall, Connectors, Workloads, Custom Pages, and Certificate Manager are examples of Platform Resource types; the naming catalog holds the complete list. The thing the reader creates is an instance, named by its Platform Resource: an Application, a Firewall, a Connector, per Name the instance by its Platform Resource.
Azion Console, the API, the CLI, the Terraform Provider, and Copilot are also Platform Resources. They are the ones the reader uses to reach the Platform, so a page can call them its interfaces: Create the Application in Console or with the API.
- Correct:
Configure a Firewall to protect the Application. - Correct: the sidebar row that opens WAF inside Firewall reads
WAF, neverFirewall WAForWeb Application Firewall, because a label never repeats its parent.
State the class of an Azion element
The sentence that defines an Azion element states its class: Platform Resource or Feature. **Functions** is a Platform Resource that runs JavaScript code on Azion's distributed infrastructure. A Feature carries its scope: Tiered Cache is a Feature of Cache that….
The class follows the documentation’s nomenclature, not the naming catalog’s list of Products:
| The element | Its class on a page | Examples |
|---|---|---|
| The root of a documentation section | Platform Resource, even when the catalog also lists it as a Product | Applications, Firewall, Functions, Object Storage, Workloads |
| Nested in a Platform Resource, whatever the catalog lists it as | Platform Resource | Cache, Application Accelerator, Image Processor, Load Balancer, Origin Shield, Live Ingest, WAF, Network Shield, Bot Manager, Certificate Manager, Custom Pages, DDoS Protection |
| A functionality of the Platform or of a Platform Resource, in neither list | Feature, with its scope | Tiered Cache, custom firewall rules, DNSSEC |
Product is a go-to-market term that names an offering, not a class: a page never states it as the class of an element.
-
Once per page, at the element’s first definition. That is the first sentence of an Overview, each entry of its resources section, the sentence of a concept page that introduces the element, a glossary row that defines it, and the first sentence of any other page that says what the element is.
-
A mention in passing carries no class.
Create a FirewallandOpen the Applicationstay as they are. A changelog entry describes a change, not the element, and keeps the opening that Changelog pages sets. -
The class does not replace the concept. The class says what the element is within Azion. The concept sentences after it still say what the class of thing is with any vendor: a reverse proxy is a server in front of your origins.
-
Brazilian Portuguese writes the classes as
recurso da plataformaandfeature:**Functions** é um recurso da plataforma que executa código JavaScript na infraestrutura distribuída da Azion. -
Correct:
**Applications** is a Platform Resource that processes the requests received by your Workloads. -
Incorrect:
Applications is a product.The class is wrong. -
Incorrect:
Application Accelerator is a Product that…Product is not a class on a page. -
Incorrect:
Functions is a serverless product.A market category replaces the class.
Classify what lives inside a resource
The words module and add-on are retired. What a page used to call a module is a Platform Resource nested in another and turned on there, such as Application Accelerator, Image Processor, WAF, or Network Shield. It can also be a feature of a resource, such as Tiered Cache, or a Function instantiated on an Application or a Firewall. The retirement covers the classification of an Azion offering, nothing else.
- Correct:
Web Application Firewall (WAF) is a Platform Resource that inspects the HTTP and HTTPS requests that reach a Firewall. Apply a WAF rule set to the Firewall. - Incorrect:
Firewall is a product that includes WAF. - Incorrect:
WAF is a Product that… - Incorrect:
WAF is a Firewall module.
Modules stays where the Console renders it, inside a click path: In the **Modules** section, turn on Application Accelerator. A JavaScript module, an ES module, and an API field such as modules.application_accelerator keep their names.
Give a plural-form name a singular verb
A Platform Resource name names one thing, whatever its form. Applications, Functions, and Connectors each take a singular verb: Applications caches content, Functions runs your code — never Applications cache. Brazilian Portuguese agrees the same way: Functions executa as suas Functions, never executam.
Name the instance by its Platform Resource
The thing a customer creates with a Platform Resource takes that resource’s name, in the singular, capitalized, and never translated, in both languages:
| Platform Resource | One instance | Several | Brazilian Portuguese |
|---|---|---|---|
| Applications | an Application | Applications | uma Application, as suas Applications |
| Firewall | a Firewall | Firewalls | um Firewall, os seus Firewalls |
| Functions | a Function | Functions | uma Function |
| Connectors | a Connector | Connectors | um Connector |
| Workloads | a Workload | Workloads | um Workload |
An Azion element with a name of its own that Console or the naming catalog lists as a resource follows the same rule: a Function Instance, the instance of a Function on an Application or a Firewall, and a Network List.
Three things stay common nouns, in lowercase:
- An element whose name is not a resource name: a rule, a behavior, a bucket, a cache setting, a deployment, an origin, a zone, a record. Brazilian Portuguese uses the word its pages already use:
uma regra,um bucket,um deployment. - The customer’s own software, the app on the origin:
your application,a sua aplicação. - The generic concept in the concept sentences of a definition block, which hold for any vendor:
A firewall for web traffic is a checkpoint between clients on the internet and an application.
The reader tells the Platform Resource from its instances by the grammar. The Platform Resource takes no article and a singular verb: Applications routes…, Applications encaminha…. An instance takes an article, a possessive, or a number: an Application, your Applications, uma Application, duas Applications.
The name already ties the instance to its Platform Resource, so no sentence has to. When a sentence must say what an instance is, its class noun is entity, entidade in Brazilian Portuguese, never object or objeto: A Workload is the entity that holds your domains…. A lowercase or translated instance reads as the customer’s own app or as a generic function, and a reader who knows the product reads the translation as a different name for it.
- Correct:
Deploy your first Application. - Correct:
An Application receives the requests of a Workload once that Workload's deployment sets that Application. - Incorrect:
an application,uma aplicação,uma função, orum connectorfor the entity created in Azion. - Incorrect:
Use **Applications** to build your own Applications.The customer’s own software staysapplications.
Keep historical names in historical documents
Changelogs, release notes, and dated agreements record what was true on the day of publication. These documents keep the names they shipped with. A Terms of Service from 2020 keeps the names that were correct in 2020.
Do not rename an offering in a historical document. An updated name rewrites the record and detaches the text from its date.
Leave these terms in US English
The names of the Platform, Products, and Platform Resources are never translated, and neither is the instance, per Name the instance by its Platform Resource: Functions executa as suas Functions.
These terms are generic technical vocabulary, not Platform Resource names. They stay in US English in both languages:
data center · serverless · on-premise · template · compliance · e-commerce · e-mail · keywords · meta description · authoritative DNS
A translation creates a second name for a concept the reader already knows in US English. The documentation uses one term for one concept, on every page.
The strings edge and edge computing also stay untranslated where they already appear. That is guidance for translation, not permission to use them. New text names Azion’s distributed infrastructure instead.
Name the infrastructure
The platform runs on Azion’s distributed infrastructure, never “on the global network”. The physical site is a data center, never an edge location or a PoP. The unit of infrastructure inside a data center has no official name: write the infrastructure in the data center, never node or edge node. The network itself appears only as the Platform Resource Our Network.
Name the data center that serves the request, not a distance: from the data center nearest to your user, never close to your users or near your users. The nearest data center is chosen by latency, network conditions, and load, so never write geographically closest.