Skip to content

content: Differentiate site from project #3401

Description

@jmooring

The documentation currently uses "site" interchangeably for the project, the sites within the project, and the published output.

Definitions:

  • site: A specific instance of your project representing a unique combination of language, role, and version. While a simple project may consist of only a single site, Hugo’s multidimensional content model allows a single codebase to generate a matrix of sites simultaneously.
  • project: A collection of components used to generate one or more sites. While a project may consist of only a single site, Hugo allows a single project to generate a matrix of sites based on language, role, and version. The project serves as the parent container for the common assets and logic used across all sites within the build.
  • build artifacts: The collective output generated in the public directory.

Using build artifacts instead of something like "published site" handles both single-host and multihost projects. Example usage:

When you publish your project, Hugo renders all build artifacts to the public directory in the root of your project.

Be careful when replacing site with project in the context of configuration: some configuration settings can be site-specific.

TODO:

  • Create build artifacts glossary entry.
  • Assess and replace term usage.

We've already addressed the low hanging fruit where the use of "project" instead of "site" is obvious. The remaining candidates (~600 occurrences) require careful assessment, including living with some ambiguity.

Reference: https://discourse.gohugo.io/t/deprecations-in-v0-156-0/56732

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions