FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Vignettes as tutorials by LienReyserhove · Pull Request #290 · inbo/tutorials · GitHub

/ tutorials Public

Vignettes as tutorials - #290

Merged
florisvdh merged 53 commits into
masterfrom
vignettes-as-tutorials
Jan 27, 2022
Merged

Vignettes as tutorials#290
florisvdh merged 53 commits into
masterfrom
vignettes-as-tutorials

Conversation

Copy link
Copy Markdown
Contributor

Description

This PR contains the vignettes as tutorials, as described in #262
All vignettes can be found in the tutorials/content/tutorials folder.
One tutorial equals one vignette. The name of the file follows the convention vignette + package_name+ vignette_name.
The structure of the index.md uses the following structure:

---
title: "..."
description: "Vignette for the R package ...."
authors: ...
date: ...
categories: ["r"]
tags: ["r", "vignette", ...]
output: 
    md_document:
        preserve_yaml: true
        variant: markdown_github
---

See the vignette/tutorial at <link>

@florisvdh @peterdesmet @ThierryO the revision is all yours

Task list

  • My tutorial or article is placed in a subfolder of tutorials/content
  • 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).
  • I have included tags in the YAML header (see the tags listed in the tutorials website side bar for tags that have been used before)
  • I have added categories to the YAML header and my category tags are from the list of category tags

Previewing the pull request

Thanks to GitHub Actions, an artifact (=zip file) of the rendered website is automatically created for each pull request.

florisvdh commented Jan 27, 2022
edited
Loading

Copy link
Copy Markdown
Member

Note that currently two pull requests exist to amend this PR:

Copy link
Copy Markdown
Contributor

Note that currently two pull requests exist to amend this PR:

@florisvdh Just a suggestion: to be sure it is not forgotten, I added a 'requested changes' review. ;-)

Copy link
Copy Markdown
Member

All issue and feedback resolved, thanks for the input! A huge thanks to @LienReyserhove 👏👏👏 for hunting down all the vignettes, translating these into tutorials, and weathering the feedback and format changes. 😄 @LienReyserhove I have also updated the spreadsheet to reflect the current state.

Copy link
Copy Markdown
Member

Just spotted a dwelling 📦:

ElsLommelen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

For now I'll remove the request changes, as this is done. If needed, I can do a more thorough review tomorrow.

florisvdh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Nice work @LienReyserhove and @peterdesmet, thanks 🎉. Just a few things left as far as I could tell!

peterdesmet self-requested a review January 27, 2022 17:01

Copy link
Copy Markdown
Member

@ElsLommelen no need for a thorough review (we all had a check already, especially @florisvdh), but your approval is needed before this PR can be merged. 😄

ElsLommelen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Sorry, I didn't know that I had to approve to remove this 'request changes'. Here you are! (I trust @florisvdh did it thoroughly, no time to do it myself today.)

florisvdh merged commit 31e1dfc into master Jan 27, 2022
florisvdh deleted the vignettes-as-tutorials branch January 27, 2022 17:17
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants


Back | FazBrowse Home | New Git URL