Skip to content

estimate densities from point patterns #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 813 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
813 commits
Select commit Hold shift + click to select a range
29bf515
Merge pull request #306 from inbo/pr_template
florisvdh May 4, 2022
a4f72c9
Apply suggestions from code review
hansvancalster May 5, 2022
18938ec
relative weblinks
hansvancalster May 5, 2022
f2aac02
open source TOTP tools
hansvancalster May 5, 2022
277b9f8
drop sentence about HTTP
hansvancalster May 5, 2022
918729b
fix anchor links
hansvancalster May 5, 2022
29870b0
remove faulty claim about GitHub's default
hansvancalster May 5, 2022
85cecd3
update md file
hansvancalster May 5, 2022
c8417de
fix section cross-references
hansvancalster May 5, 2022
0872e22
redundant chunk options
hansvancalster May 5, 2022
11a7fb7
add backticks
hansvancalster May 5, 2022
ff93de0
remove vaccinate instructions
hansvancalster May 5, 2022
3660bb8
update md
hansvancalster May 5, 2022
291fc24
check global config settings
hansvancalster May 5, 2022
095c785
project-specific gitignore file from checklist
hansvancalster May 5, 2022
9896443
update md
hansvancalster May 5, 2022
c99d23d
update title to mention GitHub
hansvancalster May 5, 2022
4354873
clarifications about 2FA
hansvancalster May 5, 2022
91659f7
move sentence to more logical place
hansvancalster May 5, 2022
5aa3e93
foolproofing...;-)
hansvancalster May 5, 2022
31a7ef0
bugfix in RProfile.site
ThierryO May 17, 2022
d12bc14
Merge pull request #312 from inbo/hotfix
ThierryO May 17, 2022
f3b8da9
use remotes::install_cran() instead of utils::install.packages()
ThierryO May 18, 2022
2a36715
streamline installation
ThierryO May 18, 2022
d214a3e
automatically remove any remainig lock file due to failed prior insta…
ThierryO May 18, 2022
8a4d132
update markdown file
ThierryO May 18, 2022
46ab938
use default repositories
ThierryO May 18, 2022
c9948f0
make the user remove 00LOCK manually
ThierryO May 18, 2022
7c42478
instruct user to run R instead of the installer
ThierryO May 18, 2022
bbd5274
update markdown
ThierryO May 18, 2022
b7f2cc4
display error when INBO package are missing
ThierryO May 18, 2022
4aded0f
render index.md
ThierryO May 19, 2022
8c74bd6
Merge pull request #314 from inbo/hotfix2
florisvdh May 19, 2022
40b226a
Update content/tutorials/git_authentication/index.Rmd
hansvancalster Jun 8, 2022
5c2e40b
address review comments Floris
hansvancalster Jun 8, 2022
a1be588
missing required INBO packages yields a warning instead of an error.
ThierryO Jun 10, 2022
8f21cad
Merge pull request #315 from inbo/hotfix
ThierryO Jun 10, 2022
b28fdc2
minor tweaks
hansvancalster Jun 15, 2022
d07012c
update md file
hansvancalster Jun 15, 2022
072b325
Update content/tutorials/git_authentication/index.Rmd
hansvancalster Jun 15, 2022
cd53ac4
Update content/tutorials/git_authentication/index.Rmd
hansvancalster Jun 15, 2022
7c9cdac
Update content/tutorials/git_authentication/index.Rmd
hansvancalster Jun 15, 2022
9631f16
address review comments
hansvancalster Jun 15, 2022
18f76b6
remove accidental carriage return
hansvancalster Jun 15, 2022
7f26e30
better explain for whom tutorial is intended
hansvancalster Jun 16, 2022
9128b08
add weblinks to install TOTP mobile apps
hansvancalster Jun 16, 2022
45bd585
update md file
hansvancalster Jun 16, 2022
8418ae9
Merge pull request #309 from inbo/issue-287-git-authentication
hansvancalster Jun 16, 2022
bc32c64
render index.md
ThierryO Jun 21, 2022
7961448
Merge pull request #316 from inbo/hotfix
ThierryO Jun 21, 2022
1cc4143
Remove tutorial gbif issue
damianooldoni Nov 23, 2022
f2390c1
Split tutorial in two
damianooldoni Nov 23, 2022
aaf6ec6
Add new vignettes
damianooldoni Nov 23, 2022
4419871
Update vignette taxon names
damianooldoni Nov 23, 2022
4a23b5b
update authors rgbif vignette
damianooldoni Nov 23, 2022
898b6d9
Improve author filename
damianooldoni Nov 23, 2022
64f5ac6
Use id as author's filename
damianooldoni Nov 23, 2022
15ca0eb
Update version of checkout and upload-artifact actions
damianooldoni Nov 23, 2022
8254301
Merge pull request #318 from inbo/improve-rgbif-vignettes
damianooldoni Nov 25, 2022
17cd2b9
Add Rmd and images
damianooldoni Dec 9, 2022
50d1c5c
Finalize Rmd and render md
damianooldoni Dec 9, 2022
8f54d1e
Add R part about datasets at INBO
damianooldoni Dec 12, 2022
c9904ea
Add section about INBO as hosting institute
damianooldoni Dec 12, 2022
0efc739
Add link to rgbif in intro
damianooldoni Dec 14, 2022
df75405
Rephrase intro
damianooldoni Dec 14, 2022
dd2e354
Rephrase sentence reason behind tutorial
damianooldoni Dec 14, 2022
4291214
Improve punctuation
damianooldoni Dec 14, 2022
6988a02
Add forgotten text: datasetKey
damianooldoni Dec 14, 2022
3180d7c
Improve sentence
damianooldoni Dec 14, 2022
3ac6fc1
Add article
damianooldoni Dec 14, 2022
cab6109
Avoid repetition
damianooldoni Dec 14, 2022
78a6fec
Add "also"
damianooldoni Dec 14, 2022
4f1522b
Knit to md
damianooldoni Dec 14, 2022
8ba870f
Merge pull request #319 from inbo/retrieve_gbif_checklist_in_r
damianooldoni Dec 14, 2022
1b2acb0
r_gbif_checklist: some fixes
florisvdh Dec 14, 2022
01730d2
r_gbif_checklist: another text fix (Rmd only)
florisvdh Dec 14, 2022
ba6d22a
Improve title and description
damianooldoni Dec 14, 2022
a452235
Improve parts about keys
damianooldoni Dec 14, 2022
fd6dd4b
Knit
damianooldoni Dec 14, 2022
df64e4a
Update content/tutorials/r_gbif_checklist/index.Rmd
damianooldoni Dec 15, 2022
c4bc01d
rephrase
damianooldoni Dec 15, 2022
7b05f70
rephrase taxonID
damianooldoni Dec 15, 2022
e93c6c9
Improve nubKey description
damianooldoni Dec 15, 2022
8bf1d94
Correct typo
damianooldoni Dec 15, 2022
76368e8
Knit again
damianooldoni Dec 15, 2022
536b525
Merge pull request #320 from inbo/r_gbif_checklist_fixes
damianooldoni Dec 15, 2022
5b8f5c8
git_zenodo: new tutorial
florisvdh Dec 22, 2022
5e57c9e
git_zenodo: update title
florisvdh Dec 23, 2022
8afb958
git_zenodo: extend wrt communities
florisvdh Dec 23, 2022
69e2f33
git_zenodo: add notes wrt editing metadata
florisvdh Dec 23, 2022
749f44b
git_zenodo: elaborate on good git tags
florisvdh Dec 23, 2022
92f887f
git_zenodo: add alternative to find URLs (thanks @ThierryO)
florisvdh Dec 23, 2022
a24f411
git_zenodo: commit new images that I forgot to stage
florisvdh Dec 23, 2022
fa66c3c
git_zenodo: refer to checklist for .zenodo.json automation (thanks @T…
florisvdh Dec 23, 2022
1a83e05
git_zenodo: use packages.inbo.be instead of inbo.github.io
florisvdh Dec 23, 2022
cb8ad18
Merge pull request #321 from inbo/zenodo
florisvdh Dec 23, 2022
e85f489
spatial_mgrs: start article on MGRS
florisvdh May 5, 2023
7db836f
Allow raw HTML to be left as-is by Hugo *
florisvdh Jul 12, 2023
425f768
spatial_wms: update WMS URL
florisvdh Jul 12, 2023
6c21f2c
Merge pull request #324 from inbo/wms
florisvdh Jul 31, 2023
840cfc8
spatial_mgrs: various minor improvements
florisvdh Aug 21, 2023
ccd2a95
spatial_mgrs: improve section on software
florisvdh Aug 21, 2023
02b453f
spatial_mgrs: major rewrite & expansion
florisvdh Aug 25, 2023
63e5e98
spatial_mgrs: knit
florisvdh Aug 25, 2023
787a909
update url's and mention inbospatial
hansvancalster Aug 31, 2023
6f0992e
Merge pull request #326 from inbo/fix-issue-#325
hansvancalster Sep 5, 2023
9b5f441
Merge branch 'master' into mgrs
florisvdh Sep 18, 2023
0f2487c
spatial_mgrs: link citations
florisvdh Sep 18, 2023
26d0fa5
spatial_mgrs: textual updates
florisvdh Sep 18, 2023
14b891d
spatial_mgrs: knit
florisvdh Sep 18, 2023
f8dec10
spatial_mgrs: add figures
florisvdh Sep 18, 2023
e9b00de
spatial_mgrs: improve portions of UTM referencing
florisvdh Sep 22, 2023
640d591
spatial_mgrs: improve figures & captions
florisvdh Sep 22, 2023
12b5f42
spatial_mgrs: language fix
florisvdh Sep 22, 2023
d1931fc
spatial_mgrs: update date
florisvdh Sep 22, 2023
a5f67dd
spatial_mgrs: fix csl filepath (no tempdir since index.md hardcodes it)
florisvdh Sep 22, 2023
f7224fa
CSS: use italic, smaller font & padding for captions
florisvdh Sep 22, 2023
b78e67a
spatial_mgrs: knit and include all assets
florisvdh Sep 22, 2023
4e494f1
spatial_mgrs: include support for pdf output
florisvdh Sep 22, 2023
f944dac
Revert "spatial_mgrs: fix csl filepath" and drop the csl file *
florisvdh Sep 25, 2023
4461f41
spatial_mgrs: fix spelling & grammar
florisvdh Sep 27, 2023
cc942f2
spatial_mgrs: update coordinate output formatting
florisvdh Sep 27, 2023
35d2423
spatial_mgrs: flip args in coord formatting code for educational reasons
florisvdh Sep 27, 2023
0f11540
spatial_mgrs: reword sentence in MGRS criticisms (thanks @wlangera)
florisvdh Sep 27, 2023
414c773
spatial_mgrs: improve punctuation
florisvdh Sep 27, 2023
d2ad5bc
spatial_mgrs: adopt easting/northing terms (thanks @hansvancalster)
florisvdh Sep 27, 2023
d3ced7c
spatial_mgrs: explain main lettering principles of MGRS
florisvdh Sep 27, 2023
26c9a93
spatial_mgrs: knit
florisvdh Sep 27, 2023
a46adfd
spatial_mgrs: code style fix
florisvdh Sep 27, 2023
ecb6226
spatial_mgrs: add NGA's own advice on when (not) to use MGRS
florisvdh Sep 27, 2023
89e76ed
spatial_mgrs: improve figure caption
florisvdh Sep 27, 2023
b16032d
spatial_mgrs: refer to NGA's appendix wrt making UTM grid references …
florisvdh Sep 27, 2023
f55c6d0
spatial_mgrs: minor addition to MGRS lettering principles
florisvdh Sep 29, 2023
43281d7
spatial_mgrs: use same location as UTM-grid in MGRS example
florisvdh Sep 29, 2023
2f1bfb4
spatial_mgrs: improve wording & grammar
florisvdh Sep 29, 2023
e84bad1
spatial_mgrs: move part of summary to intro
florisvdh Sep 29, 2023
9e923d6
spatial_mgrs: add grid reference examples in summary (thanks @ToonHub)
florisvdh Sep 29, 2023
8c7fbba
spatial_mgrs: explain the grid pattern complexities of UTM & MGRS better
florisvdh Sep 29, 2023
a1ec17f
spatial_mgrs: further explain degree of match between UTM & MGRS
florisvdh Sep 29, 2023
83aa1aa
spatial_mgrs: minor layout update
florisvdh Sep 29, 2023
bf8750e
spatial_mgrs: fix and better explain separators in UTM & MGRS
florisvdh Sep 29, 2023
cc18815
spatial_mgrs: also refer to Snyder (1987)
florisvdh Oct 2, 2023
aa96605
spatial_mgrs: minor rewordings
florisvdh Oct 2, 2023
c87eeb8
spatial_mgrs: knit
florisvdh Oct 2, 2023
9ab5ada
spatial_mgrs: MGRS is also in polar regions (summary)
florisvdh Oct 2, 2023
5af3741
spatial_mgrs: improve wording in summary
florisvdh Oct 4, 2023
ac69d55
spatial_mgrs: better explain historical entwinement between UTM & MGRS
florisvdh Oct 4, 2023
194e1ad
spatial_mgrs: update date
florisvdh Oct 4, 2023
60c89d4
spatial_mgrs: knit
florisvdh Oct 4, 2023
2f7b146
spatial_mgrs: always use latest CSL version
florisvdh Oct 23, 2023
c871ee3
spatial_mgrs: address several comments from @jeverbeu and @robsonnasc…
florisvdh Oct 23, 2023
6a54659
spatial_mgrs: add info & example about MGRS digits (thanks @jeverbeu,…
florisvdh Oct 23, 2023
b31b4c3
spatial_mgrs: update color in maps
florisvdh Oct 23, 2023
7629270
spatial_mgrs: align examples
florisvdh Oct 23, 2023
ebc3025
spatial_mgrs: minor fix
florisvdh Oct 23, 2023
9317ead
spatial_mgrs: add acknowledgements
florisvdh Oct 23, 2023
1d672eb
spatial_mgrs: update date
florisvdh Oct 23, 2023
dafbb56
spatial_mgrs: knit
florisvdh Oct 23, 2023
56e3175
custom.css: update style of class 'csl-entry' *
florisvdh Oct 23, 2023
decf1da
Merge pull request #327 from inbo/mgrs
florisvdh Oct 23, 2023
e95415a
GHA workflows: use latest Ubuntu LTS
florisvdh Nov 14, 2023
998f784
Merge pull request #328 from inbo/gha
florisvdh Nov 20, 2023
7fc002c
add missing packages
hansvancalster Dec 1, 2023
8a955b4
add qgisprocess
hansvancalster Dec 1, 2023
998d03d
Update content/articles/inbo_software/index.md
hansvancalster Dec 4, 2023
49c23a7
add geoprocessing section
hansvancalster Dec 4, 2023
19a1088
Merge pull request #329 from inbo/update-inbo-software-page
hansvancalster Dec 4, 2023
d389d0f
git_authentication: replace andOTP by Aegis *
florisvdh Dec 4, 2023
5c342fe
Merge pull request #330 from inbo/aegis
florisvdh Dec 4, 2023
2255e13
Rprofile.site: add option qgisprocess.detect_newer_qgis = TRUE *
florisvdh Dec 20, 2023
746d9f6
Merge pull request #331 from inbo/florisvdh-patch-1
ThierryO Dec 20, 2023
5e46f0d
Create raisacarmen.toml
RCinbo Jan 2, 2024
8a11a76
add authors .toml
raiisac Jan 2, 2024
e3b3aec
Add index.md for the r_brms toturial
raiisac Jan 2, 2024
62f0161
Refer to static htmls
raiisac Jan 2, 2024
11342e3
Add static htmls
raiisac Jan 2, 2024
3e3a2fc
Add links to course material
raiisac Jan 2, 2024
1dde43f
Add english course material
raiisac Jan 2, 2024
2402677
Add Dutcj course material
raiisac Jan 2, 2024
af9e982
user_install_r: fix typo
florisvdh Jan 9, 2024
6fc3262
Merge pull request #333 from inbo/florisvdh-patch-1
ThierryO Jan 9, 2024
9c0a1e0
Improbve broken links to course material
damianooldoni Jan 10, 2024
7b772e2
Add link to brms package homepage
damianooldoni Jan 10, 2024
e5627cb
Add link to R script for installation
damianooldoni Jan 10, 2024
c6fe8a4
Improve link to installation R script
damianooldoni Jan 10, 2024
59356d1
Merge pull request #332 from inbo/RCinbo-bayesianstatistics
RCinbo Jan 10, 2024
a2cdec2
tutorial on solving merge conflict on GitHub.com
ThierryO Apr 17, 2024
23041da
move tutorial to its own folder
ThierryO Apr 17, 2024
798ca43
Apply suggestions from code review
ThierryO Apr 25, 2024
36ca13e
Merge pull request #334 from inbo/merge_conflict
ThierryO Apr 25, 2024
ce07a89
update Rprofile.site
ThierryO Jul 19, 2024
a7e7a6c
Create index.md
fredericpiesschaert Sep 30, 2024
db2dda2
Update index.md
fredericpiesschaert Sep 30, 2024
d8eae5d
Update index.md
fredericpiesschaert Oct 1, 2024
f5f89e0
Merge pull request #335 from inbo/install
ThierryO Oct 8, 2024
2430e51
Update baseurl
damianooldoni Oct 21, 2024
5676c86
Merge pull request #339 from inbo/adapt-settings-post-url-change
damianooldoni Oct 21, 2024
0ae3676
Remove `baseurl`
damianooldoni Oct 21, 2024
b78f8dc
Merge pull request #340 from inbo/remove-baseurl
damianooldoni Oct 21, 2024
8c0c8d6
Merge branch 'master' into fredericpiesschaert-patch-1
ElsLommelen Oct 31, 2024
2a41086
Update index.md
EmmaCartuyvels1 Oct 31, 2024
71e1297
add author elslommelen
ElsLommelen Oct 31, 2024
6c7e9c5
Create index.md
fredericpiesschaert Sep 30, 2024
8a7b99f
Update index.md
fredericpiesschaert Oct 1, 2024
de7a458
correct names
ElsLommelen Oct 31, 2024
880875e
Merge pull request #337 from inbo/fredericpiesschaert-patch-1
damianooldoni Nov 4, 2024
8eeeb6f
Update installation instructions RStudio
ElsLommelen Nov 7, 2024
b14b081
Merge pull request #345 from inbo/Update-suggestion-for-installation-…
ThierryO Nov 7, 2024
d09e99e
brms_rstan: general updates
falkmielke Nov 21, 2024
184f59a
Merge pull request #344 from inbo/EmmaCartuyvels1-patch-1
EmmaCartuyvels1 Nov 21, 2024
7b170ac
brms_rstan: poisson model, plain+hierarchical
falkmielke Nov 21, 2024
bfa0a19
brms_rstan: windows testing, index, author
falkmielke Nov 22, 2024
d3a0159
brms-rstan: wording
falkmielke Nov 26, 2024
e17c1a8
brms-rstan: wording (nl)
falkmielke Nov 26, 2024
b487a1e
brms-rstan: wording (nl)
falkmielke Nov 26, 2024
fc2f757
brms-rstan: wording (nl)
falkmielke Nov 26, 2024
194ee75
brms-rstan: wording (nl)
falkmielke Nov 26, 2024
bb32e0d
brms-rstan: rstan moved as suggested.
falkmielke Nov 26, 2024
0d113dd
brms-rstan: generalizing frequentists; translation
falkmielke Nov 26, 2024
58dc8af
brms-rstan: generalizing frequentists (en)
falkmielke Nov 26, 2024
4740347
brms-rstan: mentioning cmdstanr backend
falkmielke Nov 26, 2024
4f731a9
brms-rstan: re-organize static files
falkmielke Nov 26, 2024
75efd94
brms-rstan: knit files; image issues
falkmielke Nov 26, 2024
9b93611
Switch to using artifacts v4
PietrH Nov 27, 2024
316e518
Merge pull request #350 from inbo/349-switch-to-artifacts-v4
damianooldoni Nov 27, 2024
a3556f5
r_database_access: update argument of dbConnect()
florisvdh Dec 3, 2024
fde1619
Merge pull request #351 from inbo/database_access
florisvdh Dec 3, 2024
8c46fb7
Merge pull request #346 from inbo/rstan
falkmielke Dec 6, 2024
643b62b
fix url
ThierryO Jan 27, 2025
0d91d27
Merge pull request #354 from inbo/inbomd
ThierryO Jan 27, 2025
f983c76
Update pull_request_template.md
florisvdh Feb 10, 2025
2f67cb9
update_pr_template: introduce
falkmielke Feb 13, 2025
8060599
update_pr_template: *cf.* consistency
falkmielke Feb 14, 2025
d9a9724
update_pr_template: proofread "create tutorial"
falkmielke Feb 14, 2025
0698666
update_pr_template: refresh pr template
falkmielke Feb 14, 2025
5bf6856
update_pr_template: additional suggestions*
falkmielke Feb 20, 2025
4608880
Merge pull request #357 from inbo/update_pr_template
florisvdh Feb 21, 2025
6d7631a
add rmd file on estimating densities from point patterns
ThierryO Jun 28, 2017
ba66028
point-pattern: move files in correct location
florisvdh Jun 23, 2020
98f0c5a
point-pattern: rename Rmd
florisvdh Jun 23, 2020
424eadf
spatial_point_pattern: underscores in folder
florisvdh Sep 16, 2020
1d07b8a
spatial_point_pattern: add gfm md_document outputformat in YAML
florisvdh Sep 16, 2020
9e2ae59
spatial_point_pattern: use PROJ>=6 compliant CRS
florisvdh Sep 16, 2020
34ef686
spatial_point_pattern: use proj4string<- function rather than the slot *
florisvdh Sep 16, 2020
70c5660
spatial_point_pattern: expand on CRS/proj4string/WKT2
florisvdh Sep 16, 2020
dc8572f
spatial_point_pattern: improve markdown & language
florisvdh Sep 16, 2020
b714e11
Use frontmatter used elsewhere
peterdesmet Jan 28, 2022
dafed22
density: remove ancient _site.yml
falkmielke Mar 12, 2025
19ea897
density: revival
falkmielke Mar 12, 2025
18aad03
density: rebase / merge conflicts
falkmielke Mar 12, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
57 changes: 57 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<!--- indicate the Title for this pull request (PR) above -->

<!--
Thank you for contributing to the INBO tutorials repository.
-->

## Description
<!--- Briefly describe the tutorial or article that you want to contribute
or update-->
<!--- You can mention collaborators with "@githubname"-->


## Related Issue
<!--- if this closes an issue make sure to include e.g., "closes #4"
or similar - or if it just relates to an issue make sure to mention
it like "#4" -->
<!--See https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword-->


## Task list

<!--see https://docs.github.com/en/github/managing-your-work-on-github/about-task-lists
for an explanation on how to use task lists-->

<!-- Please check if the following steps are OK:-->

- [ ] 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](https://github.com/inbo/tutorials/blob/master/static/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](https://inbo.github.io/tutorials/)).
- [ ] 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

1) 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.
2) Decompress it into a target directory, e.g. `Downloads/tutorials_preview`.
3) To preview the website, use a program which can serve `http` sites on your local machine. One such option is [the `servr` package](https://github.com/yihui/servr) 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 [...]`).
4) Point your browser to http://localhost:8887.
5) 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`](https://docs.python.org/3/library/http.server.html): `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](https://github.com/inbo/tutorials?tab=readme-ov-file#building-the-site)); the Hugo preview server will update changes on the fly.
This requires [Hugo](https://gohugo.io/getting-started) to be installed on your computer.
45 changes: 45 additions & 0 deletions .github/workflows/deploy-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Build the site and deploy to GitHub pages

on:
push:
branches:
- master

jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout (tutorials)
uses: actions/checkout@v3
with:
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: Checkout (theme)
uses: actions/checkout@v3
with:
repository: MunifTanjim/minimo
ref: v2.9.0
path: themes/minimo

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.88.1'
# extended: true

- name: Build
run: hugo

# Need to add post build for the search functionality...
- name: Install JS dependencies to build the index
run: npm install lunr glob

- name: Generate search index
run: node themes/minimo/scripts/generate-search-index-lunr.js

- name: Deploy 🚀
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: public
46 changes: 46 additions & 0 deletions .github/workflows/generate-artifact-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: On PR, build the site and save the result to an artifact

on:
pull_request

jobs:
build-and-save:
runs-on: ubuntu-latest
steps:
- name: Checkout (tutorials)
uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: Checkout (theme)
uses: actions/checkout@v3
with:
repository: MunifTanjim/minimo
ref: v2.9.0
path: themes/minimo

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.88.1'
# extended: true

- name: Build
run: hugo

# Need to add post build for the search functionality...
- name: Install JS dependencies to build the index
run: npm install lunr glob

- name: Generate search index
run: node themes/minimo/scripts/generate-search-index-lunr.js

- name: Archive built site to an artifact
uses: actions/upload-artifact@v4
with:
name: pr-${{ env.PR_NUMBER }}-inbo-tutorials-website
path: public
env:
PR_NUMBER: ${{ github.event.number }}
18 changes: 18 additions & 0 deletions .github/workflows/remove_old_artifact.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Remove old artifacts

on:
schedule:
# Every day at 1am
- cron: '0 1 * * *'

jobs:
remove-old-artifacts:
runs-on: ubuntu-latest
timeout-minutes: 10

steps:
- name: Remove old artifacts
uses: c-hive/gha-remove-artifacts@v1
with:
age: '1 days'
skip-recent: 5
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,10 @@ content/**/*.html

# Temporary download files
2016-04-20-processed-logs*

# Local folders with binary data
data_gisclub/

# png images for the brms tutorial
/content/tutorials/r_brms/brms_eng/*.png
/content/tutorials/r_brms/brms_nl/*.png
40 changes: 0 additions & 40 deletions .travis.yml

This file was deleted.

Loading