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.

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

tag learnr tutorials with extra metadata? #312

Closed
kevinushey opened this issue Dec 16, 2019 · 3 comments · Fixed by #313
Closed

tag learnr tutorials with extra metadata? #312

kevinushey opened this issue Dec 16, 2019 · 3 comments · Fixed by #313

Comments

@kevinushey
Copy link
Collaborator

kevinushey commented Dec 16, 2019

As part of the Tutorial pane work in the RStudio IDE, I'd like to make a landing page for all discovered tutorials provided by any installed packages. It currently looks like this:

Screen Shot 2019-12-16 at 3 10 18 PM

The presentation is currently a bit bare. I wonder if there is some other relevant metadata we could include for a particular tutorial, e.g.

  • A short, single-paragraph description? [description]
  • The R package(s), if any, one might learn about in this tutorial? [packages]

The format I'm currently imagining would be something like:

Data Basics [ex-data-basics]

Learn about the base data types in R. Explore R's data frames, and learn how to interact with data frames and their columns using dplyr.

Packages: dplyr, tibble

All the relevant data here could be included as part of the YAML header.

@coatless
Copy link
Contributor

@kevinushey any way to render a thumbnail of the tutorial in the pane?

@kevinushey
Copy link
Collaborator Author

Not currently, but we could allow for something like icon.png if that would be helpful.

@coatless
Copy link
Contributor

@kevinushey that would be great. Though, might need to enforce image size (storage + display).

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 a pull request may close this issue.

2 participants