Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename files to be 1-indexed #172

Merged
merged 5 commits into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default defineAppConfig({
nav: [
{
label: 'Start',
to: '/getting-started',
to: '/getting-started/overview',
},
{
label: 'Guides',
Expand Down
2 changes: 1 addition & 1 deletion content/community/3.codebase/2.dev-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This guide explains how to set up and run a development environment for Directus

::callout{icon="material-symbols:warning-rounded" color="amber"}
**Not For Production**
This is specifically for contributing to the codebase of Directus. To run Directus, refer to [our guide on creating a project](/getting-started).
This is specifically for contributing to the codebase of Directus. To run Directus, refer to [our guide on creating a project](/getting-started/overview).
::

## Requirements
Expand Down
2 changes: 1 addition & 1 deletion content/guides/9.extensions/1.quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This guide will cover how to get started with developing an extension for Direct

## Loading an Extension Volume

Follow the steps in the [Create a Project](/getting-started) guide to set up your project locally. This `docker-compose.yml` file will set up a local volume for extensions to be loaded from. This directory exists on your local filesystem and is also mounted into the Docker container.
Follow the steps in the [Create a Project](/getting-started/overview) guide to set up your project locally. This `docker-compose.yml` file will set up a local volume for extensions to be loaded from. This directory exists on your local filesystem and is also mounted into the Docker container.

Add the following to the `environment` section of your `docker-compose.yml` file to automatically reload your extensions when they are rebuilt:

Expand Down
2 changes: 1 addition & 1 deletion content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ navigation: false
title: Platform Overview
description: Get starting with using Directus.
icon: simple-icons:directus
to: /getting-started
to: /getting-started/overview
class: col-span-6
---
:::
Expand Down
2 changes: 1 addition & 1 deletion content/self-hosting/3.deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This also means your project will not be automatically updated to the latest ver

Docker containers are ephemeral by design. This means that any changes you make while the container is running will be lost when the container is stopped or restarted.

To persist data, you will need to mount a volume to the container. When using Docker Compose, this is done by adding a `volumes` section to the `docker-compose.yml` file, which you can see in our [create a project page](/getting-started/).
To persist data, you will need to mount a volume to the container. When using Docker Compose, this is done by adding a `volumes` section to the `docker-compose.yml` file, which you can see in our [create a project page](/getting-started/overview).

Files can be persisted by mounting a volume to the container, or by setting up an [external storage location](/configuration/files).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In this tutorial, you will learn how to set up an Android project with Kotlin an

## Before You Start
You will need:
- A Directus project - follow our [quickstart guide](/getting-started) if you don't already have one.
- A Directus project - follow our [quickstart guide](/getting-started/overview) if you don't already have one.
- knowledge of Kotlin
- [Android Studio](https://developer.android.com/studio) installed on your computer

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You will need:

1. To have Xcode installed on your macOS machine.
2. Knowledge of the Swift programming language.
3. A Directus project - follow our [quickstart guide](/getting-started) if you don't already have one.
3. A Directus project - follow our [quickstart guide](/getting-started/overview) if you don't already have one.

## Create Post Structs and Helpers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: Learn how to integrate Directus in your Angular web application.
## Before You Start

- Some knowledge of TypeScript and [Angular](https://angular.io/)
- A Directus project. Follow the [Quickstart guide](/getting-started) to create one.
- A Directus project. Follow the [Quickstart guide](/getting-started/overview) to create one.
- [Node.js](https://nodejs.org/en/download) and a development environment of your choice
- Install the Angular CLI - use the Angular [guide](https://angular.io/guide/setup-local) to achieve this.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: Learn how to integrate Directus in your Astro web application.
You will need:

- To install [Node.js](https://nodejs.org/en/) and a code editor on your computer.
- A Directus project - you can use [Directus Cloud](https://directus.cloud/) or [run it yourself](/getting-started).
- A Directus project - you can use [Directus Cloud](https://directus.cloud/) or [run it yourself](/getting-started/overview).
- Some knowledge of TypeScript and Astro framework

## Initializing Astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Django is a popular Python framework known for its "battery included" philosophy
You will need:

- Python installed and a code editor on your computer.
- A Directus project - Use the [quickstart guide](/getting-started) to create a project if you dont already have one.
- A Directus project - Use the [quickstart guide](/getting-started/overview) to create a project if you dont already have one.


## Create a Django Project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Eleventy (sometimes referred to 11ty) is a lightweight and unopinionated static
You will need:

- Node.js and a code editor.
- A Directus project - [follow our quickstart guide](/getting-started) if you don't already have one.
- A Directus project - [follow our quickstart guide](/getting-started/overview) if you don't already have one.

Open your terminal and run the following commands to create a new 11ty project and the Directus JavaScript SDK:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: Learn how to integrate Directus in your Flask web application.
You will need:

- To have Python installed on your machine
- A Directus project - [follow our quickstart guide](/getting-started) if you don't already have one.
- A Directus project - [follow our quickstart guide](/getting-started/overview) if you don't already have one.
- Knowledge of Python and Flask

### Creating Page Templates
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: Learn how to integrate Directus in your Flutter app with Dart.
You will need:

- Flutter SDK: Follow the official [Flutter installation guide](https://docs.flutter.dev/get-started/install) for your operating system (Windows, macOS, or Linux). This will also install the Dart programming language, which is required for Flutter development.
- A Directus project - [follow our quickstart guide](/getting-started) if you don't already have one.
- A Directus project - [follow our quickstart guide](/getting-started/overview) if you don't already have one.
- A code editor installed.
- Knowledge of Dart.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You will need:
- [PHP 7.4](https://www.php.net/releases/7_4_0.php) or higher
- [Composer](https://getcomposer.org/)
- A code editor on your computer.
- A Directus project - follow our [quickstart guide](/getting-started) if you don't already have one.
- A Directus project - follow our [quickstart guide](/getting-started/overview) if you don't already have one.
- Some knowledge of Laravel.

The code for this tutorial is available on my [GitHub repository](https://github.com/directus-labs/blog-example-getting-started-laravel).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: Learn how to integrate Directus in your SolidStart web application.
You will need:

- Node.js and a code editor.
- A Directus project - [follow our quickstart guide](/getting-started) if you don't already have one.
- A Directus project - [follow our quickstart guide](/getting-started/overview) if you don't already have one.
- (Bonus) SolidJS knowledge will definitely help, but is not required.

## Initialize SolidStart Project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You will need:

- Knowledge of Java programming language and Thymeleaf templating.
- [Java development kit(JDK)8](https://www.oracle.com/ke/java/technologies/javase/javase8-archive-downloads.html) or above.
- Directus project - Use the [quickstart guide](/getting-started) if you don't already have one.
- Directus project - Use the [quickstart guide](/getting-started/overview) if you don't already have one.
- An IDE with support for Java.

In your Directus project, set up a collection named `articles` with the fields `id`, `title`, `featuredImage`, and `body`. These fields will be used to store the contents of an article. In your Access Control settings, grant public read access to the `articles` and `directus_images` collections.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: Learn how to integrate Directus in your SvelteKit web application.
You will need:

- To install Node.js and a code editor on your computer.
- A Directus project - follow our [quickstart guide](/getting-started) if you don't already have one.
- A Directus project - follow our [quickstart guide](/getting-started/overview) if you don't already have one.
- Some knowledge of Svelte.

## Initialize SvelteKit Project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You will need:

1. To have Xcode installed on your macOS machine.
2. Knowledge of the Swift programming language.
3. A Directus project - follow our [quickstart guide](/getting-started) if you don't already have one.
3. A Directus project - follow our [quickstart guide](/getting-started/overview) if you don't already have one.

Create a `posts` collection with the `created_by` and `created_on` optional fields. Also create a `title` and `content` field.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You will need:

- [Node.js v20.11.1](https://nodejs.org/) or later.
- A code editor on your computer.
- A Directus project - follow our [quickstart guide](/getting-started) if you don't already have one.
- A Directus project - follow our [quickstart guide](/getting-started/overview) if you don't already have one.
- Some knowledge of React and Svelte.

The code for this tutorial is available on this [GitHub repository](https://github.com/directus-labs/blog-example-sveltekit-i18n).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This article will guide you through building a Chrome extension using Vite and D

When a user clicks the extension while browsing a webpage, it will automatically capture the URL of the current webpage and prompt the user to add a `note`. Users will be able to `view`, `edit`, and `delete` their notes directly from the extension. This tutorial will not cover styling the extension, but light styling has been applied to the screenshots shown.

Before you start, you will need a Directus project. Follow the [Quickstart guide](/getting-started) to create one if needed.
Before you start, you will need a Directus project. Follow the [Quickstart guide](/getting-started/overview) to create one if needed.

## Set Up Your Directus Project

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In this tutorial, we will setup a testimonial widget using SvelteKit and Directu
You will need:

- To install Node.js and a code editor on your computer.
- A Directus project - follow our [quickstart guide](/getting-started) if you don't already have one.
- A Directus project - follow our [quickstart guide](/getting-started/overview) if you don't already have one.
- Some knowledge of Svelte and SvelteKit.

## Setting Up Your Directus Project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Before we hop 🐰 in , here’s what you’ll need to follow along:

**Tooling**

- A Directus instance up and running (either [self-hosted](/getting-started) or on [Directus Cloud](https://directus.cloud/))
- A Directus instance up and running (either [self-hosted](/getting-started/overview) or on [Directus Cloud](https://directus.cloud/))
- A Vue.js project set up ([Using Vite is recommended](https://vuejs.org/guide/scaling-up/tooling.html#tooling))

## Preparing Directus Collection
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You will need:

- [Node.js v20.11.1](https://nodejs.org/) or later.
- A code editor on your computer.
- A Directus project - follow our [quickstart guide](/getting-started) if you don't already have one.
- A Directus project - follow our [quickstart guide](/getting-started/overview) if you don't already have one.
- Some knowledge of SvelteKit.

You can find the code for this tutorial in the [GitHub repository](https://github.com/directus-labs/blog-example-video-streaming-app-sveltekit).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ E-commerce websites are among the most popular for businesses as they enable cus
You will need:

- [Node.js](https://nodejs.org/en) installed and a code editor on your computer.
- A Directus project - you can use [Directus Cloud](https://directus.cloud/) or [run it yourself](/getting-started).
- A Directus project - you can use [Directus Cloud](https://directus.cloud/) or [run it yourself](/getting-started/overview).
- A [Stripe](https://stripe.com/) account with a business already set up
- [Stripe CLI](https://docs.stripe.com/stripe-cli) installed in your computer
- Some knowledge of TypeScript and React.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Internet of Things (IoT) systems often need to log their collected data. In this

You will need:

- A Directus project - [follow our quickstart guide](/getting-started) if you don't already have one.
- A Directus project - [follow our quickstart guide](/getting-started/overview) if you don't already have one.
- Either the list of physical components below, or a [A Wowki Club account](https://wokwi.com/club) that will allow you to simulate the hardware.

### Components List
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In this tutorial, you will learn how to implement pagination and infinite scroll

You will need:

- A Directus project - follow the [quickstart](/getting-started) guide to create a project if you don’t have one already.
- A Directus project - follow the [quickstart](/getting-started/overview) guide to create a project if you don’t have one already.
- Knowledge of Next.js.

## Adding Data to Directus
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ the endpoint).

## Before You Start

You will need a Directus project - check out our [quickstart guide](/getting-started)
You will need a Directus project - check out our [quickstart guide](/getting-started/overview)
if you don't already have one. You will also need a
[Vonage Developer API account](https://developer.vonage.com/sign-up), taking note of your API Key and Secret.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Panels can only talk to internal Directus services, and can't reliably make exte

## Add an Extensions Volume

Follow our Directus [Self-Hosted Quickstart](/getting-started), adding a volume for extensions:
Follow our Directus [Self-Hosted Quickstart](/getting-started/overview), adding a volume for extensions:

```
volumes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In this article, we will explore how to index data from Directus in Algolia, ena

## Setting Up Directus

You will need to have a [local Directus project running](/getting-started) to develop extensions.
You will need to have a [local Directus project running](/getting-started/overview) to develop extensions.

In your new project, create a collection called `posts` with a `title`, `content`, and `author` field.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In this article, we will explore how to index data from Directus in Elasticsearc

## Setting Up Directus

You will need to have a [local Directus project running](/getting-started) to develop extensions.
You will need to have a [local Directus project running](/getting-started/overview) to develop extensions.

In your new project, create a collection called `books` with a `title` and a `description` field.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In this article, we will explore how to index data from Directus in Meilisearch

## Setting Up Directus

You will need to have a [local Directus project running](/getting-started) to develop extensions.
You will need to have a [local Directus project running](/getting-started/overview) to develop extensions.

In your new project, create a collection called `articles` with a `title`, `content`, and `author` field.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This guide covers setting up Docker, configuring Docker Compose, using Nginx as

## Upload Your Local Directus Application Folder to the Server

If you have successfully followed the [Self-Hosted Quickstart](/getting-started), you should have a directory with a `docker-compose.yml` file, `database/` directory with a `data.db` file, `uploads/` directory, and `extensions/` directory.
If you have successfully followed the [Self-Hosted Quickstart](/getting-started/overview), you should have a directory with a `docker-compose.yml` file, `database/` directory with a `data.db` file, `uploads/` directory, and `extensions/` directory.

Use `scp` (Secure Copy Protocol) to upload the local folder to your server.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In this guide, you will learn how to use Directus Automate with Confirmation Pro

## Before You Start

You will need a [Directus project](/getting-started) and a GitHub Personal Access Token with "Read and Write Issues" permissions.
You will need a [Directus project](/getting-started/overview) and a GitHub Personal Access Token with "Read and Write Issues" permissions.

You'll also need a GitHub repository on GitHub to create the issues.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Vonage Number Insight V2 API assigns a fraud score to numbers, along with a

## Before You Start

You will need a Directus project - check out [our quickstart guide](/getting-started) if you don't already have one. You will also need a [Vonage Developer API account](https://developer.vonage.com/sign-up), taking note of your API Key and Secret. You should also have a high-risk number to test with (I used the last spam caller I had).
You will need a Directus project - check out [our quickstart guide](/getting-started/overview) if you don't already have one. You will also need a [Vonage Developer API account](https://developer.vonage.com/sign-up), taking note of your API Key and Secret. You should also have a high-risk number to test with (I used the last spam caller I had).

Finally, in Your Directus project, add an input field called `phone_number` to the `directus_users` collection. This is a system collection, so you will need to expand them in the Data Model settings in order to see the `directus_users` collection.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In this quick project, you will set up a new Flow with [Directus Automate](https

## Before You Start

You will need a Directus project - check out [our quickstart guide](/getting-started) if you don't already have one. You will also need a [Clearbit account](https://dashboard.clearbit.com/signup) and API Key.
You will need a Directus project - check out [our quickstart guide](/getting-started/overview) if you don't already have one. You will also need a [Clearbit account](https://dashboard.clearbit.com/signup) and API Key.

The `directus_users` collection has some profile fields by default - including `email`, `description`, and `location`. As a demonstration of being able to add additional data provided by Clearbit, go into your Data Model settings, and open the `directus_users` system collection. Add a string input field called `phone`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Directus Automate provide a really powerful interface to integrating with AI ser

## Before We Start

You will need a [Directus project](/getting-started) and an OpenAI API Key from your account dashboard.
You will need a [Directus project](/getting-started/overview) and an OpenAI API Key from your account dashboard.

In your Directus project, create a new collection called `posts` with the following fields:
- `title`: input, string
Expand Down
Loading