Adding a new tutorial about EMD, with relevance for ecohydrology.
It has code examples for R and Python.
Open TODO's
Content-wise, this is ready (I used quarto render for proofing).
Because code in R and Python is used, this relies on the .panel-tabset feature of quarto.
It would be great if this paneling could make it to our hugo style.
Another missing integration are the callout-boxes of various colors; two were added in #352 (see /layouts/shortcodes/callout.html and /static/css/custom.css).
I added my previous qmd->md notes, but currently lack the time for this technical follow-up.
Support is much appreciated!
Technical note: for the callout box requirement, and because this text just celebrated its anniversary, I attempted to rebase to master to get it up to date. I am usually clumsy at rebasing, kind of failed again, but think everything is in order now. Apologies if something went wrong: changes were restricted to this branch, and all files should be in one subfolder, so do not hesitate to spin this up anew.
Task list
My tutorial or article is placed in a subfolder of tutorials/content/
The novel tutorial has a meaningful name, in relation to the content of the tutorial.
The filename of my tutorial or article is index.md. In case of an Rmarkdown tutorial I have knitted my index.Rmd to index.md (both files are pushed to the repo).
yaml header:
(recommended) I am included as author in the authors yaml tag, using [MY_AUTHOR_ID]. An author information file exists in <tutorials>/data/authors/<author>.toml.
I have added categories to the YAML header and my category tags are from the list of categories.
I have included meaningful and applicable tags (i.e. keywords) in the YAML header to improve the visibility of the new tutorial (see the tags listed in the tutorials website side bar).
The date is in format YYYY-MM-DD and adjusted.
(recommended) I have previewed this PR locally (see steps below; ask previous contributors for help) and confirmed that the new content renders as expected.
Previewing the pull request
Thanks to GitHub Actions, an artifact (=zip file) of the rendered website is automatically created for each pull request.
This provides a way to preview how these updates will look on the website, useful to contributors and reviewers.
Instructions to preview the updated website
On the PR page, you can find a "details" link under "checks - On PR, build the site and ...". Go there, click on the top link in the left sidebar ("Summary"), and download the generated artifact at the bottom of the page.
Decompress it into a target directory, e.g. Downloads/tutorials_preview.
To preview the website, use a program which can serve http sites on your local machine. One such option is the servr package in R: & '\C:\Program Files\R\R-4.4.2\bin\Rscript.exe' -e "servr::httd('./tutorials_preview')" -p8887 (make sure to adjust the path to your Rscript.exe; on Linux, simply use Rscript -e [...]).
Review the updated website. As a contributor, you can push extra commits to update the PR. As a reviewer, you can accept/refuse/comment the PR.
Note: for step 3, you can use any other simple HTTP server to serve the current directory, e.g. Python http.server: python -m http.server 8887 --bind localhost --directory path/to/tutorials_preview
Alternative: Locally Building the Site
Alternatively, you can build the entire site locally (see the README for instructions); the Hugo preview server will update changes on the fly.
This requires Hugo to be installed on your computer.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adding a new tutorial about EMD, with relevance for ecohydrology.
It has code examples for R and Python.
Open TODO's
Content-wise, this is ready (I used quarto render for proofing).
Because code in R and Python is used, this relies on the .panel-tabset feature of quarto.
It would be great if this paneling could make it to our hugo style.
Another missing integration are the callout-boxes of various colors; two were added in #352 (see /layouts/shortcodes/callout.html and /static/css/custom.css).
I added my previous qmd->md notes, but currently lack the time for this technical follow-up.
Support is much appreciated!
Technical note: for the callout box requirement, and because this text just celebrated its anniversary, I attempted to rebase to master to get it up to date. I am usually clumsy at rebasing, kind of failed again, but think everything is in order now. Apologies if something went wrong: changes were restricted to this branch, and all files should be in one subfolder, so do not hesitate to spin this up anew.
Task list
Previewing the pull request
Thanks to GitHub Actions, an artifact (=zip file) of the rendered website is automatically created for each pull request.
This provides a way to preview how these updates will look on the website, useful to contributors and reviewers.
Instructions to preview the updated website
Note: for step 3, you can use any other simple HTTP server to serve the current directory, e.g. Python http.server: python -m http.server 8887 --bind localhost --directory path/to/tutorials_preview
Alternative: Locally Building the Site
Alternatively, you can build the entire site locally (see the README for instructions); the Hugo preview server will update changes on the fly.
This requires Hugo to be installed on your computer.