QUICKSTART.md

Quick Start

1. Create a repo from this template

   In the top-right of this GitHub repo, select the green button that says "Use this template".

   IMPORTANT: When creating your repo from this template, check the box that says, "Include all branches". This is required because the hosted publication is managed on a separate branch.

2. Configure your publication

   • Replace the variables in _variables.yml
     • The google_analytics_id field can be left blank during development, but should be populated before publishing. See the Publishing Guide for more details.
   • Feel free to edit the variables in authors.yml.
     • Ultimately, Publishing Team will provide you with an authors.yml based on the contributor roles they assign for the publication, so this isn't necessary.

3. Install Quarto

   The publication is rendered with Quarto. If you don't have it installed (check with quarto --version), you can install it here.

4. Set up your environment

   See the Environment Setup Guide for complete instructions.

5. Register your publication

   If you intend to publish your analysis, fill out the "Kick off a new pub" form on the AirTable Publishing toolkit.

6. Create your publication

   Edit index.ipynb to create your publication. As you work, you can render a live preview of your changes with:

   make preview

   Then, commit your changes to a development branch and merge them into main using our usual PR-based workflow.

   As you work, please be careful to avoid modifying any files in the following directories:

   • /_extensions (Quarto extensions)
   • /_freeze (Generated execution results)
   • /_site (Generated website files)

   These files are all either necessary to build the publication or are automatically generated during the publication process.

7. Publishing

   See the Publishing Guide for complete instructions on the publishing process.