Setting up pages

Set up your codebase to use Pages

Unlike folders (the current organizational unit in the Airplane Library), Pages are configured in your codebase. This means that adding, removing, and reorganizing Pages to build your Airplane Library is as simple as editing your filesystem.

To opt into pages, create a library/ folder at the top level of your Airplane project, next to your airplane.yaml project configuration file. Every directory within that library/ folder will become a Page, and upon deployment, your Airplane Library will mimic the directory structure of your codebase.

For most teams, you can get started by simply dropping all of your tasks and views into a library/ folder and then deploying. Once you deploy, your Airplane Library will exactly mirror your filesystem. Note that any folders you've created from the UI will be ignored, and any existing tasks or views that were not in the library/ directory will be shown in a separate page from the main Airplane Library. Switching to Pages can be easily reverted.

Tasks and views can still be defined outside of the library/ folder, but will be hidden from the main UI and will appear under "All tasks" in the sidebar. This allows you to define tasks that may be called from other tasks or views, without cluttering your Airplane Library. By leaving those tasks out of the library/ folder, you can ensure that only a curated set of tasks is shown.

Setup

Ensure that you create a library/ folder at the root level of your Airplane project, which is the same place your airplane.yaml lives. The contents of this folder are your "library."

Every directory within the library becomes a Page in your Airplane Library.
Every task and view within the library appears on their corresponding Page, or if not in a subdirectory, directly on the homepage.
Every task and view outside the library is still deployed, and can be referenced by other tasks and views, but will not show up in the main Airplane Library. These show up under "All tasks".

Walkthrough

Let's take a look at an illustrative example. Suppose our directory structure is as follows:


Copied
1
airplane/ ⭐ PROJECT ROOT
2
┣ library/
3
┃ ┣ top_level_task.airplane.ts
4
┃ ┣ support/
5
┃ ┃ ┗ my_task_airplane.py
6
┃ ┗ sales/
7
┃   ┣ nested_page/
8
┃   ┃ ┗ rest_task.task.yaml
9
┃   ┣ my_sales_task.airplane.ts
10
┃   ┣ sales_query.sql
11
┃   ┣ sales_query.task.yaml
12
┃   ┗ my_view.airplane.tsx
13
┣ other_task.airplane.ts
14
┣ airplane.yaml
15
┣ package.json
16
┗ requirements.txt

other_task is not under library/, so it will appear under the separate "All tasks" page and will not appear in your Airplane Library.
top_level_task and the sales and support Pages will appear on the Airplane homepage since they are directly under library/.

Within each page, you can see the constituent tasks, views, and subpages.

Page contents can be viewed as either a list or as cards.

Previewing in studio

When you're developing in Studio, you'll be able to see a preview of what your Library will look like in the left sidebar, and you can click on individual Pages to preview them.

Reverting Pages

If you've tried out Pages and they aren’t the right fit for you, you can deploy your tasks without the library/ folder, and the Airplane Library will revert to how it was previously, folder structure and all. This means you can try out Pages risk-free!

Wrapping up