Skip to content

torieketcham/www_marinebon2

 
 

Repository files navigation

MBON marinebon.org Webite

This is a work-in-progress rebuild of the marinebon.org website. Details on how to make edits are below. This site is built using wowchemy and although some basic tasks are outlined below the excellent wowchemy docs are highly recommended reading.

Site Editing Workflow

If you're just getting started here it is likely you just want to edit content on one of the pages. There are several ways to do this but a checklist for how to do this in the easiest way is below. Other common tasks are outlined below (like editing the nav menu) and for more information see the wowchemy getting started page.

General content editing workflow checklist

The basics of how to edit content on an existing page. Note that the "home" page is different and weird because it is currently using wowchemy widgets.

  1. Edit website content files in /content/ and commit the changes to github using one of:
  2. Your git commit will show up in the commit history and be saved in github's copy of the git repo.
  3. The new commit will trigger Netlify to build and deploy the site. The job will show up at app.netlify.com/sites/marinebon2/deploys.
  4. Once the status of the Netlify deploy build is "Published" your changes should be live on the project website marinebon2.netlify.app.
    • Errors in the build can be debugged by looking at the deploy log on netlify

Above is the most basic workflow for editing the content on this website but advanced users can also develop using the typical git workflow and hugo to do test builds without needing to commit and rely on Netlify builds.

Editing the Nav Menu

Modify the ./config/_default/menus.toml entries to define menu items. To define sub-menu items use the parent attribute as explained in this issue.

Local Dev Workflow

Wowchemy is designed to leverage lots of free cloud tools to allow CMS & WYSiWYG editing with minimal technical knowledge, but sometimes digging deeper into things is helpful. The wowchemy "edit on your pc" page outlines how to get set up building the site on your local machine rather than relying on netlify (or github actions or travis CI or whatever). This is useful for editing without needing to do a commit - something that is especially valuable when making lots of small test changes (looking at you, CSS) or debugging build issues.

Useful tools

Upstream Tech

This website is built starting from the Academic Template for Hugo.

Wowchemy was used to set up this website. The site can be edited your site in Markdown, Jupyter, or RStudio (via Blogdown). Netlify is used to build the site with Hugo and deploy hosting on Netlify. A CMS is provided for editing the site using Netlify (or is this a Wowchemy tech?).

About

MBON Website 2021 Rebuild in progress

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 57.8%
  • HTML 38.6%
  • TeX 3.6%