Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

41 lines (25 loc) · 1.42 KB

Contributing

Development Environment

Use the included devcontainer for local development.

Start the container and run hugo serve to start a development server.

To view draft files, run hugo serve -D.

The development server can be viewed in a browser at http://localhost:1313.

Project Layout

This repository uses the standard Hugo directory structure.

Here are some general guidelines to follow:

  • Site content should go in content
  • HTML layouts (e.g. for landing pages) should go in layouts
  • Section content (e.g. partners, announcements, docs, etc.) should include an archetype template in archetypes (see section on archetypes below)
  • Global assets (e.g. CSS, JavaScript, images used in more than one location, etc.) should go in assets
    • Page-specific assets should be alongside the page itself in the content directory

Using Archetypes to Generate New Content

Hugo archetypes provide a template for creating new content.

Once an archetype template is created, it can be used like this:

# Create a new partner
hugo new _partners/dask-sql

# Create a new announcement
hugo new announcements/cuda-12-deprecation

Pull Request Previews

Netlify will create a preview environment when PRs are opened.