Skip to content

Commit c7e7c33

Browse files
bryantgillespieCopilotLZylstra
authored
Docs Updates #3 - Cleanup "Product" Language (#668)
* update all dependencies * add packageManager back * remove hardcoded url * wip * cleanup from review * cleanup again * switch to json for storing redirects * convert to ts * cleanup * ai cleanup * Update README.md * backfill all ids * feat(nav): rename Connect→APIs, Automate→Flows, Manage→Hosting * feat(llms): rename guide section titles to APIs and Flows * docs: replace branded "Directus Connect"/"Directus Automate" with APIs/Flows * docs(homepage): drop Data Engine/Data Studio framing * fix: fold 11.integrations into 12.integrations to clear numeric collision * fix sidebar * docs(nav): rename Guides→Guide, Hosting→Deploy * kill editor and explorer * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix: simplify redirect and stable id tooling * docs: clean up flows terminology * docs: fix flows product link grammar --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: LZylstra <11338479+LZylstra@users.noreply.github.com>
1 parent 6cd0ea7 commit c7e7c33

43 files changed

Lines changed: 108 additions & 102 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

app/app.config.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export default defineAppConfig({
3737
to: '/getting-started/overview',
3838
},
3939
{
40-
label: 'Guides',
40+
label: 'Guide',
4141
children: [
4242
{
4343
label: 'Data Model',
@@ -55,7 +55,7 @@ export default defineAppConfig({
5555
icon: 'directus-auth',
5656
},
5757
{
58-
label: 'Connect',
58+
label: 'APIs',
5959
to: '/guides/connect/authentication',
6060
icon: 'directus-connect',
6161
},
@@ -65,7 +65,7 @@ export default defineAppConfig({
6565
icon: 'directus-files',
6666
},
6767
{
68-
label: 'Automate',
68+
label: 'Flows',
6969
to: '/guides/automate/flows',
7070
icon: 'directus-automate',
7171
},
@@ -107,7 +107,7 @@ export default defineAppConfig({
107107
],
108108
},
109109
{
110-
label: 'Manage',
110+
label: 'Deploy',
111111
children: [
112112
{
113113
label: 'Cloud',

app/components/content/ProductLink.vue

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,28 @@ const props = defineProps<{
33
product: keyof typeof linkMap;
44
}>();
55
6-
const name = computed(
7-
() => props.product.charAt(0).toUpperCase() + props.product.slice(1),
8-
);
9-
106
const linkMap = {
117
'auth': '/guides/auth/tokens-cookies',
128
'automate': '/guides/automate/flows',
139
'content': '/guides/content/explore',
1410
'connect': '/guides/connect/authentication',
1511
'data-model': '/guides/data-model/collections',
16-
'editor': '/guides/content/editor',
17-
'explore': '/guides/content/explore',
1812
'extensions': '/guides/extensions/overview',
1913
'files': '/guides/files/upload',
2014
'insights': '/guides/insights/overview',
2115
'realtime': '/guides/realtime/subscriptions',
2216
} as const;
17+
18+
const labelMap: Partial<Record<keyof typeof linkMap, string>> = {
19+
'automate': 'Flows',
20+
'connect': 'APIs',
21+
'data-model': 'Data Model',
22+
};
23+
24+
const name = computed(
25+
() => labelMap[props.product]
26+
?? props.product.charAt(0).toUpperCase() + props.product.slice(1),
27+
);
2328
</script>
2429

2530
<template>
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
::shiny-grid{class="lg:grid-cols-2"}
22
:::shiny-card
33
---
4-
title: Data Engine
5-
description: APIs and developer tools for your data.
4+
title: APIs and Developer Tools
5+
description: Build with REST, GraphQL, the SDK, realtime, auth, and Flows.
66
color: purple
77
---
88
:product-link{product="connect"} :product-link{product="realtime"} :product-link{product="auth"} :product-link{product="automate"}
@@ -11,9 +11,9 @@
1111
:::shiny-card
1212
---
1313
title: Data Studio
14-
description: A data web app your whole team will love.
14+
description: A web app for your whole team to manage content, files, users, and dashboards.
1515
color: pink
1616
---
17-
:product-link{product="explore"} :product-link{product="editor"} :product-link{product="insights"} :product-link{product="files"}
17+
:product-link{product="insights"} :product-link{product="files"}
1818
:::
1919
::

content/community/2.contribution/2.documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ We care about writing succinct, inclusive, and well-considered documentation. To
2222

2323
For tutorials, we use the imperative mood instead of the gerund form. For example - "Build an Extension to Show Cat Pictures" instead of "Building an Extension to show cat pictures."
2424

25-
We end each title with technologies and product used, lowercasing the word 'with' before the tools. For example "Send SMS Messages with Twilio and Directus Automate."
25+
We end each title with technologies and product used, lowercasing the word 'with' before the tools. For example "Send SMS Messages with Twilio and Directus Flows."
2626

2727
#### Contextualizing and Setting Goals
2828

content/community/3.codebase/1.overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ navigation:
66
title: Codebase
77
---
88

9-
The :icon{name="simple-icons:github"} [directus/directus](https://github.com/directus/directus) repository includes the Data Studio, Directus Connect, the JavaScript SDK, and a number of smaller packages used internally. All of these live in a single monorepo.
9+
The :icon{name="simple-icons:github"} [directus/directus](https://github.com/directus/directus) repository includes the Data Studio, the API server, the JavaScript SDK, and a number of smaller packages used internally. All of these live in a single monorepo.
1010

1111
## Data Studio
1212

content/getting-started/1.overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
stableId: 8d6c731d-b669-41e7-8549-3b641969fb4e
33
title: Overview
44
headline: Getting Started
5-
description: Learn about the Directus Data Engine and Studio, when to use it, and how it works.
5+
description: Learn what Directus is, when to use it, and how it works.
66
navigation:
77
title: Overview
88
---
99

10-
Directus is a backend for building your projects. Connect it to your database, asset storage, and external services, and immediately receive rich developer tooling (Data Engine) and a comprehensive web application (Data Studio) to work with your data. Granular access control means users can only see, interact with, and create the data their role allows.
10+
Directus is a backend for building your projects. Connect it to your database, asset storage, and external services, and immediately get a REST and GraphQL API, an SDK, realtime, auth, file management, automations, and a web application to work with your data. Granular access control means users can only see, interact with, and create the data their role allows.
1111

1212
:partial{content="engine-studio-box"}
1313

content/getting-started/7.create-an-automation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
stableId: 2f1467c4-ca73-4826-a674-f0e7b6a3afd9
3-
title: Create an Automation
4-
description: Get started using flows, triggers, operations and the data chain in Directus Automate.
3+
title: Create a Flow
4+
description: Get started using flows, triggers, operations, and the data chain in Directus.
55
navigation:
6-
title: Create an Automation
6+
title: Create a Flow
77
---
88

99
:video-embed{video-id="6e6965e7-13cc-4f86-b512-f567d66cfbe9"}
1010

11-
This guide will cover custom event-driven data processing using Directus Automate.
11+
This guide will cover custom event-driven data processing using Flows.
1212

1313
## Before You Start
1414

content/guides/01.data-model/1.collections.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ There are two types of collections: **user collections** and **system collection
1212

1313
## Creating Collections
1414

15-
**User collections** are created directly in your database or via Directus. They describe your specific data models and configurations and can be queried via APIs created by :product-link{product="connect"} or via :product-link{product="explore"}.
15+
**User collections** are created directly in your database or via Directus. They describe your specific data models and configurations and can be queried via APIs created by :product-link{product="connect"} or browsed on the [collection page](/guides/content/explore).
1616

1717
You can create collections from the Data Model settings in the Directus Data Studio, or using the [Collections API](/api/collections).
1818

@@ -65,7 +65,7 @@ Once a collection is created, there are a number of configuration options availa
6565

6666
### Content Versioning
6767

68-
Content versioning is used by :product-link{product="editor"} and allows teams to create and manage different versions of their content. There are several reasons to use content versioning, including drafting content without publishing it, and more ways to collaborate with others.
68+
Content versioning is used on the [item page](/guides/content/editor) and allows teams to create and manage different versions of their content. There are several reasons to use content versioning, including drafting content without publishing it, and more ways to collaborate with others.
6969

7070
This feature can be enabled for specific collections, and will be available for all items. Once enabled, item versions can be created, and later have some or all fields promoted to the main version, typically used for publishing.
7171

@@ -75,7 +75,7 @@ Read the content versioning user guide.
7575

7676
### Live Preview
7777

78-
Live preview is used by :product-link{product="editor"} and allows for your application to be shown in a pane next to your content, which can be used for previewing content before publishing.
78+
Live preview is used on the [item page](/guides/content/editor) and allows for your application to be shown in a pane next to your content, which can be used for previewing content before publishing.
7979

8080
You can use item field values to construct the URL used by the live preview, including unique identifiers and content version, allowing for previewing content versions before promoting them to the main version.
8181

@@ -109,7 +109,7 @@ Once configured, click :icon{name="material-symbols:sort" title="Sort Button"} i
109109

110110
### Duplication
111111

112-
The **Save as Copy** option in :product-link{product="editor"} offers a way to effectively duplicate the current item. Duplication settings define which field values will be copied.
112+
The **Save as Copy** option on the [item page](/guides/content/editor) offers a way to effectively duplicate the current item. Duplication settings define which field values will be copied.
113113

114114
::callout{icon="material-symbols:info-outline"}
115115

content/guides/01.data-model/2.fields.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ When creating a new field, you must first select an [interface](/guides/data-mod
3030

3131
![Field creation form showing datetime field](/img/426fb648-1e88-46e4-92f1-af76f3254d25.webp)
3232

33-
The **interface** describes how users will create and edit data, as well as how it is displayed in :product-link{product="editor"}. There are many kinds of built-in interface, such as a text input, date selector, map, and a set of relationship interfaces. More interfaces can be built as [extensions](/guides/extensions/overview).
33+
The **interface** describes how users will create and edit data, as well as how it is displayed on the [item page](/guides/content/editor). There are many kinds of built-in interface, such as a text input, date selector, map, and a set of relationship interfaces. More interfaces can be built as [extensions](/guides/extensions/overview).
3434

3535
The **key** is the unique name for a field within a collection. This value is used in both the Data Studio and via API. Within the Data Studio, the key is parsed through our title formatter to improve readability.
3636

content/guides/01.data-model/3.interfaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Interfaces
44
description: Manage your data effectively with Directus fields. Discover various field types, interfaces, validations, and relationships to perfectly suit your data modeling needs.
55
---
66

7-
Interfaces are how users interact with fields in :product-link{product="editor"}. Each interface supports specific data types and configurations.
7+
Interfaces are how users interact with fields on the [item page](/guides/content/editor). Each interface supports specific data types and configurations.
88

99
## Text & Numbers
1010

0 commit comments

Comments
 (0)