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

Move tutorials to Quarto #638

Merged
merged 15 commits into from
Jul 11, 2023
Merged

Move tutorials to Quarto #638

merged 15 commits into from
Jul 11, 2023

Conversation

mateuszbaran
Copy link
Member

I've moved hand gesture tutorial to Quarto, I think it makes it easier to discover. And Quarto is nice.

I'm thinking about moving the chart/atlas tutorials but then we would lose all interactivity.

@mateuszbaran mateuszbaran added documentation Improvements or additions to documentation preview docs Add this label if you want to see a PR-preview of the documentation labels Jun 30, 2023
@mateuszbaran mateuszbaran reopened this Jun 30, 2023
@codecov
Copy link

codecov bot commented Jun 30, 2023

Codecov Report

Merging #638 (e5a966e) into master (6168554) will decrease coverage by 0.06%.
The diff coverage is n/a.

❗ Current head e5a966e differs from pull request most recent head 8af3b5b. Consider uploading reports for the commit 8af3b5b to get more accurate results

@@            Coverage Diff             @@
##           master     #638      +/-   ##
==========================================
- Coverage   99.20%   99.14%   -0.06%     
==========================================
  Files         106      106              
  Lines       10215    10210       -5     
==========================================
- Hits        10134    10123      -11     
- Misses         81       87       +6     

see 8 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

docs/Project.toml Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
@mateuszbaran
Copy link
Member Author

Hm, GLMakie.jl doesn't work on CI. @kellertuer , what do you think about rendering images locally and uploading them? How should I do that?

@kellertuer
Copy link
Member

I think there are two possibilities, either pretender just the one image and load it in the file or quarto render the whole example, commit the md file and the rendered images.

I would prefer the second I think, and do the same with two tutorials in Manopt.jl as well, you just have to exclude them then here in the _quarto.yml, see https://github.com/JuliaManifolds/Manopt.jl/blob/master/tutorials/_quarto.yml

You can also see that both markdown files and some images are actually committed https://github.com/JuliaManifolds/Manopt.jl/tree/master/docs/src/tutorials

For the regression example the reason is the same as yours, we do not have Asymptote on CI, the other one just runs too long on CI.

@mateuszbaran
Copy link
Member Author

I went with the first option, it looks a bit easier.

@mateuszbaran mateuszbaran added the Ready-for-Review A label for pull requests that are feature-ready label Jul 2, 2023
@kellertuer
Copy link
Member

I will try to find time to review this tomorrow. At first glance: You created two quarto notebooks but only deleted one old jl file. What about the other one?

@mateuszbaran
Copy link
Member Author

I haven't deleted the "working in charts" .jl file because it still has some interactivity parts that couldn't be ported to the Quarto version.

Copy link
Member

@kellertuer kellertuer left a comment

Choose a reason for hiding this comment

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

Here are a few comments, overall – nice to have them in the new format. I hope we get a few more somewhen (maybe one on metrics, one on Lie,...)

docs/make.jl Outdated Show resolved Hide resolved
tutorials/Project.toml Show resolved Hide resolved
tutorials/hand-gestures.qmd Show resolved Hide resolved
tutorials/hand-gestures.qmd Outdated Show resolved Hide resolved
tutorials/hand-gestures.qmd Outdated Show resolved Hide resolved
tutorials/hand-gestures.qmd Outdated Show resolved Hide resolved
tutorials/hand-gestures.qmd Outdated Show resolved Hide resolved
tutorials/working-in-charts.qmd Outdated Show resolved Hide resolved
tutorials/hand-gestures.qmd Outdated Show resolved Hide resolved
tutorials/working-in-charts.qmd Show resolved Hide resolved
@mateuszbaran
Copy link
Member Author

Here are a few comments, overall – nice to have them in the new format. I hope we get a few more somewhen (maybe one on metrics, one on Lie,...)

Yes, Quarto looks nice. I think I will keep using it for new tutorials.

@kellertuer
Copy link
Member

In VS Code there is also a live html preview (Live as in re-render per save action, not as live as Pluto). Then writing these tutorials is very nice – and I feel a bit better fitting than Pluto even.

Copy link
Member

@kellertuer kellertuer left a comment

Choose a reason for hiding this comment

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

(given that tests pass)

Thanks for moving these :)

@mateuszbaran mateuszbaran merged commit 7afc7af into master Jul 11, 2023
@kellertuer kellertuer deleted the mbaran/move-to-quarto branch May 4, 2024 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation preview docs Add this label if you want to see a PR-preview of the documentation Ready-for-Review A label for pull requests that are feature-ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants