paketo-website

Website for Paketo Buildpacks

Development

Prerequisites

• Hugo (extended version)
• npm

Navigating this repo

• HTML lives in layouts/, including partials (HTML snippets) that are reused across multiple pages.
• SCSS and Javascript live in assets/
• Much of the CSS uses the BEM naming methodology.
• Hugo automatically compiles our SCSS into CSS. This is a feature of Hugo extended version.

Serving Locally

To Serve docs at http://localhost:1313:

npm install && hugo server

Contributing

• Open a PR against the main branch if you'd like to make a change to the site.
  • When you open a PR, a GHA will automatically deploy an ephemeral version of the staging site based on your PR branch. Check the GHA logs for the URL to your staging site
• Join website-related conversations in the #website channel of the Paketo slack instance.

Deployment

This repo uses a GHA workflow to automatically deploy commits on main to the Paketo site using GitHub Pages.

This repo uses a GHA workflow to automatically deploy commits on develop to the permanent staging site. For large UX changes, consider opening your pull request against develop instead of main to allow more time to test the feature before deploying to prod.