This site remains hosted, however, and some parts of this site are used by the new site via iframe elements.
The parts of this site linked are listed here:
iframe src | target |
---|---|
marinebon.org/publications/ | /publication/ |
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.
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.
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.
/content/
and commit the changes to github using one of:
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.
index.md
within /content/post for your news post.
index.md
by editing the name of index.md
, adding your folder name followed by a /
. Github should automatically create the folder. Watch the .gif here for further clarification.index.md
. The "header" is everything at the top of the file between the pair of three dashes (---
)index.md
file to write your articlefeatured.png
image:filename:featured
part of the index.md
headerUpdating publications requires a bit of technical know-how for now, but this can be automated easily in the future.
The most important step below is the first one.
Once you have completed step (1) then a site admin can quickly and easily complete the remaining steps.
A prerequisite to these steps is to have a .bibtex file.
.bibtex
files are human-readable adn can be generated a number of ways.
MBON's references are currently managed using Zotero, instructions for exporting a .bibtex
can be found on this old issue post.
based on wowchemy instructions to import-from-bibtex
/content/publication/MBON_publications.bib
/content/
directory? (not sure yet)academic import --normalize --bibtex content/publication/MBON_publications.bib
to run the python import scriptgit commit -a -m 'update pubs'
git push
It is relatively easy to add a "MBON Data or Software Product" to the grid display. You may open an issue for help with this but the general steps are:
featured.png
to use on the product "card grid" displayindex.md
using markdown syntax. This must include a basic header section. See other product index.md
s for examples..md
header section to set relevant tags. Tags can be anything but the most important ones are listed under "filter_button" in the widget file (/content/product/index_widget_product_grid.md). Below is a list of those tags (as of 2021-10):tag description | tag format | examples |
---|---|---|
MBON Region | region--{REGION_NAME} |
region--south-florida , region--global , region--us |
associated MBON tool(s) | tool--{TOOL_NAME} |
tool--infographiq , tool--dashboard |
associated organizations | org-{ORG_NAME} |
org-iea , org-nms , org-fwri |
product type | product_type--{TYPE} |
product_type--tool , product_type--instance , product_type--data |
product_type
: An explaination of the three types:
data
product represents publication of scientific data to be used by othersinstance
software product is something created to address the needs of a specific group and is uniquely tied to that user-story.tool
software product is something that can be used help to create instance
products. This includes frameworks, libraries, etcPublications have their own section of the website and should not be put under products. The products page exists to help users find resources they can use, so a product must link out to one of:
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.
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.
This is the order in which files are used. Files from earlier in the chain will override files later in the chain.
. | location | note | desc |
---|---|---|---|
1 | local | . | files in this repo |
2 | actual theme loc | wowchemy-hugo-themes/modules/wowchemy | |
? | template | not used. this is only the demo site. | starter-hugo-academic |
As an example: if a page is using layout=publication, marinebon/www_marinebon2/layouts/publication/
will be used if it exists, else /wowchemy/wowchemy-hugo-themes/modules/wowchemy/layouts/publication/
will be used.
We ran into issues setting up where to put media content (see #10). There are three options on where to put media:
/assets/media
/content/...
/static/media_content
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?).
Associated wowchemy repositories: