Skip to content

Adding a publication

Easton R. White edited this page Aug 22, 2021 · 5 revisions

Each paper published by a member of the team should be included on the Publications tab of the website. Only the DOI, an image, and a publication pdf are needed to post a publication. The details about the publication are generated automatically.

The first time you want to contribute to the website, you will be asked to "fork" the repository (you won't need to do this again). This fork is a personal copy of the website into your own Github account.

Within the _data/ folder there is a file named sources.yaml. Here you will find information on each publication. This information automatically generates the citations.yaml file which population the Publications page of the website. To add a publication, add an entry to the sources.yaml file using the template below. The order of entries in the file does matter. Once you have finished your changes, head to the pull request tab and click the new pull request button. Be sure to make a pull request on the main website repository as opposed to your forked version.You will then be able to request your changes be included in the main website's repo. This pull request notifies Easton of the request.

Example:

- id: 10.1111/oik.07770
  image: https://quantmarineecolab.github.io/images/journal_covers/2020_White_etal_Oikos.png
  extra-links:
    - type: pdf
      link: pdfs/2020_White_etal_Oikos.pdf
    - type: source
      link: https://github.com/eastonwhite/MPA-disturbances
      text: Code
  tags:
    - monitoring
    - marine protected areas
    - fisheries
    - spatial ecology

id

This is the most component part of the entry. It is simply the DOI of the publication. The website uses this information to extract the title, authors, etc. about the publication.

image

Each publication requires some sort of an image. The standard is to use a journal cover or representative figure about the paper. Keep in mind that the image is quite small.

`extra-links

Each paper is likely to include extra links with a minimum of a pdf link needed. A pdf of the paper should be placed in the /pdfs folder. In addition, links can include: source, blog, journal, or preprint. Other types of links could be included in the links.yaml file within the _data/ folder.

tags

List of topics/themes for the publication. It is best to keep these similar to past topics/themes used, but it is also okay to add additional ones.