Submission Guidelines

This article explains the process for submitting an article to the CESTA Anthology.

Process

%%{
    init: {
      'theme': 'base',
      'themeVariables': {
        'primaryColor': '#fff',
        'primaryTextColor': '#000',
        'primaryBorderColor': '#fff',
        'lineColor': '#F8B229'
      }
    }
  }%%

  flowchart TD
    A[Write your article in a text editor.]-->B(Share with PI for review.)
    B-->H[Request Repository]
    H-->two-->K(Submit for review)
    H-->one-->K(Submit for review)
    K-->G[Article is published in the CESTA Anthology. Yay!]

    subgraph one [Text and Images Only]
    I(Open the template in GitHub)-->N(Paste text into template)
     N-->J(Drop images into /imgs folder)
    end
  subgraph two [Make it interactive?]
     F[Clone repository]-->C(Preview locally)
     C-->D(Sync to repo)
     end

Step 1: Write the article and have PI review it

The most important part of your research article is what you write. So, go ahead and write it using a platform that will make it easy to share with the PI. (We recommend writing it in Markdown, but you can always convert it later.)

Share it with the project PI for an initial review. You will need a written approval before moving to step 2.

Step 2: Request a Repository

Create a Github accont (github.com). When you are ready to create an anthology page write an email to cesta-online@stanford.edu with the following information:

Email Info 
- Subject: Anthology Repository Request
- Body:
  - Your Github Username
  - Title of the project
  - PI approval (this can be a forwarded email from the PI)

In return, they will send you a link to a repository that will be dedicated to your anthology entry. That repository will include a template file for the anthology page with inline instructions.

Step 3:

Option 1 - Text and images only

If you are creating an article that is just text and images, we ask you to format the article using Markdown, which is a very simple markup language. You can find a guide to Markdown basics here. In your repository, using the edit function in Github, copy and paste your markdown file into the template. You will also need to drag and drop any image files you have into the images folder. (Go to Section 1.4 )

Option 2 - Make it interactive

Complete the pre-requisites

  • Install the following in your machine:

    • Git

    • Python 3.6 or later

      Using Homebrew For Mac

      For Mac, use Homebrew to install both Git and Python if you don’t have them installed already.

    • Quarto (Latest Version)

    • VS Code (Latest Version)

      • GitHub should be configured in VS Code to manage the repository easily
      • Quarto extension can be install in VS Code to preview and render the website

Clone the repository locally

- **The repository name should be in the format `anthology-{project-name}-{quarter}-{year}`. For example, `anthology-know-systemic-racism-spring-2023`.**
  • Keep the repository private.
  • The repository will contain a single template file.
  • Read through the template first and make note of the inline instructions.

Set up a virtual environment on your local machine

  • Using VS Code, clone the copied repository to your local machine
  • Open the cloned repository in VS Code
  • Open the Terminal in VS code (not the main terminal) and run the following commands
    • Setup the virtual environment using python3 -m venv .venv or python -m venv .venv
    • Activate the virtual environment using source .venv/bin/activate (Mac & Linux) or .\.venv\Scripts\Activate (Windows)
      • Important Note: You must activate the virtual environment every time you close and reopen the vscode.
    • Install the required packages using pip3 install -r requirements.txt or pip install -r requirements.txt

Build your project site

  • Preview the template using quarto preview in the VS code terminal
  • Authoring the article is done in the index.qmd file and quarto renders it automatically into webfiles in the public folder.
  • Add content to the template following the guidelines. Any changes you make will appear immediately in a browser window via Quarto preview.
  • See Quarto documentation for details about adding interactive content to your site

What happens when I close my VS Code?

When you open your VS code to work on your project again later, all you need to do is the following:

  • Open your project directory in VS Code
  • Activate the virtual environment in the VS Code terminal using source .venv/bin/activate (Mac & Linux) or .\.venv\Scripts\Activate (Windows)
  • Run quarto preview in the VS code terminal to preview the changes as you make edits to the index.qmd file

Important Tips

  • If you are adding a new Python library to the project, make sure to update the requirements.txt file
  • If a content is not getting rendered properly with the Quarto markdown syntax, often it can be fixed with adding line breaks before or after the syntax.

Step 4: Submitting the article for review

Once your article is ready for submission, write an email to cesta-online@stanford.edu with the following information:

Email Info
  • Subject: Anthology Submission: {Project Name}
  • Body:
    • The link to your repository
    • Your Github Username

The CESTA team will review your submission. If approved, it will be added to the anthology. If there are issues, they will be in touch to help you fix them.