Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation update 🎉 #26

Draft
wants to merge 79 commits into
base: main
Choose a base branch
from
Draft

Documentation update 🎉 #26

wants to merge 79 commits into from

Conversation

steffilazerte
Copy link
Member

@steffilazerte steffilazerte commented Aug 1, 2024 •
edited
Loading

This is the PR for the documentation update by @dimimarkou.

Don't worry about failing R-CMD-checks (only pkgdown matters for this PR)

If time permits

  • Existing vignettes/articles should have alt text and most don't

To Do before merging

  • Update the version number to 0.4.2 (do at the end so we get a dev documentation site in the meanwhile)

steffilazerte and others added 30 commits August 1, 2024 13:33
@steffilazerte
Add some details on how to test pkgdown docs.
2138477
@steffilazerte
Add dev version so picked up as dev documentation site.
7e4e0c0
@steffilazerte
Update workflow to build on docs-update too.
53678d4
@steffilazerte
Don't run full check on documentation branch
f14fee1
@steffilazerte
Don't run for drafts
07ee1a1
@dimimarkou
The NatureCounts R User Guides section
18c73fb
@dimimarkou
add contents component for trial run
54d5e91
@dimimarkou
title change trial commit
a233ab8
@dimimarkou
adding vignette 01-Introduction
0fe26f3
@dimimarkou
Intro Tutorial section
6fe4cbb
@dimimarkou
spelling error "Introduction"
2e141e5
@dimimarkou
renaming Chapter 1 - Introduction
9288c18
@dimimarkou
Uploading chapters 1 - 3 of Intro Tutorial
9f15c6b
@dimimarkou
introducing NatureCounts
dfbacf1
@dimimarkou
uploading chapters 1 - 3
85dd3b0
@dimimarkou
building Chapter 2
406cab0
@steffilazerte
Add missing eval FALSE
bc0bdd0
@dimimarkou
moving Chapters 1 - 3 to articles
172d7ad
@dimimarkou
moving Chapters 1 - 3 to articles
ebf7140
@dimimarkou
uploading Chapters 4 and 5
675b83b
@dimimarkou
yml file
e741bd6
@dimimarkou
reupload
040fe84
@dimimarkou
Uploading Chapter 6 - Data Visualization
7a99a0d
@dimimarkou
reupload, w/ eval = TRUE
5044dba
@dimimarkou
correcting VignetteIndexEntry (Chapter 3)
fbe1901
@dimimarkou
pushing changes from Chapter 6 - Data Visualization
3cafcfa
@dimimarkou
warning = FALSE
23f70fc
@dimimarkou
troubleshooting: added tidyverse to yaml
2d7dd49
@dimimarkou
Uploading Chapter 7 - Answers
6faefd0
@dimimarkou
adding spatial data to naturecounts
535a6e1
dimimarkou and others added 30 commits October 7, 2024 12:32
@dimimarkou
adding figures to 2.1-ManipSpatialData
2aecac2
@dimimarkou
figures path
70aad7e
@steffilazerte
Test precompile
a39e77d
@steffilazerte
Fix ref to new article
f7d143d
@steffilazerte
Omit ClimateData for now
b328e55
@steffilazerte
Try with standard figures folder and fig.alt/fig.cap
4a8f3b8
@steffilazerte
Don't process climate article
7867f15
@steffilazerte
Is it really alt text?
4669356
@steffilazerte
Nope, not alt text
44f7762
@dimimarkou
SpatialDataExploration / Conservation Areas upload
093a978
@dimimarkou
yml articles update
003c2a5
@dimimarkou
remove climate data
e35de05
@dimimarkou
remove ManipSpatialData
4d0a258
@dimimarkou
update yml, remove ManipSpatialData
9c805ec
@dimimarkou
remove authorship heading
bf389db
@dimimarkou
remove ManipSpatialData (release r)
6600842
@dimimarkou
uploading climate data
d5943d4
@dimimarkou
reupload chapter 1 and 2 with revisions
e9b1e67
@dimimarkou
upload ch 1, 2, and 3
5fc0b12
@dimimarkou
missing code chunk
1039644
@steffilazerte
Remove cache's
9bf8b87
@steffilazerte
Merge branch 'docs-update' of https://github.com/BirdsCanada/natureco…
97152d7 
…unts into docs-update
@steffilazerte
Clean up (fix some initial problems first)
9919853
@steffilazerte
Don't imply that weathercan "isn't available". It's just hosted somew…
9cb21a4 
…here else.
@steffilazerte
Fix precompiled vignettes
52d8ba5 
- Ensure clean up of old figures
- Tweak pattern match (probably doesn't matter)
- Add chunk options (opts_chunk$set())
- fig.path important for precompiled
- collapse important for spacing
- Use alt (good to do regardless), and then use fig.cap = "" to suppress caption [This is necessary to create the correct file path pattern matched in _PRECOMPILE.R]
- Remove ![plot...](figures/...) [This will be created by compiling]
@steffilazerte
Compile vignettes (and clean up)
d1b0422
@steffilazerte
Tweak ratio of map figure
a2e96ad
@dimimarkou
Title changes
a465575 
Danielle's edits transfered
@dimimarkou
removed hard coded reference to figure
4f209d9
@steffilazerte
Tweak navbar setup
74c4a97
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@steffilazerte @dimimarkou