index.airplane.yamlfile to a directory in your library in order to start customizing the Page corresponding to that directory.
descriptionfields to edit the heading and subheading of the Page, and set the
iconfield to an emoji to customize the Page's icon in the Library.
yamlCopied1# index.airplane.yaml2name: Custom name!3description: This is a very important page4icon: 🔨
Change which tasks and runbooks are displayed
library/folder at all, include those task slugs in the
additionalTasksfield. Similarly, use
additionalRunbooksto link runbooks to the Page.
hiddenTasksfield. As a shortcut, you can set it to
*to exclude all tasks in the directory. Note that
additionalTasksis applied after
hiddenTasks, so you can fully control the tasks that are shown by excluding all tasks and then specifying the exact tasks to be included in
yamlCopied1# index.airplane.yaml2name: Custom name!3description: This is a very important page4icon: 🔨5additionalTasks:6- top_level_task7hiddenTasks:8- "*"9additionalRunbooks:10- test_book
full_pagein order to open them in a new tab. Include the button label in the
labelfield and the task slug in the
taskfield. If no
labelis provided, the task slug will be used for the label.
yamlCopied1# index.airplane.yaml2name: Custom name!3description: This is a very important page4icon: 🔨5additionalTasks:6- top_level_task7hiddenTasks:8- "*"9additionalRunbooks:10- test_book11actions:12- label: Get sales data13task: sales_query14- label: Go to other task15task: other_task16as: full_page
Name of the Page.
Description of the Page.
Icon to show for the Page. Must be a single emoji.
Slugs of other tasks to show on the Page.
Slugs of tasks that were defined in the Page's directory, but shouldn't be shown on the Page. You can use the special wildcard "*" to exclude all tasks in the directory.
hiddenTasks does not affect task slugs specified in
Slugs of runbooks to show on the Page.
label, linking to the
taskaccording to the method specified by
asdefaults to "side_peek". A maximum of 3 actions are shown.