Skip to content

[doc] Renew the tutorials #1397

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
Merged
merged 9 commits into from
Jul 9, 2020
Merged

[doc] Renew the tutorials #1397

merged 9 commits into from
Jul 9, 2020

Conversation

@vkarak
Copy link
Contributor

@vkarak vkarak commented Jul 5, 2020

  • The first introductory is completely rewritten from scratch. Now it starts from the generic configuration that ships with ReFrame and expands both the configuration and the test concepts along the way. It should be now feasible to start with the tutorials with practically zero effort.
  • The previously called "Advanced tutorial" is now renamed to "Miscellaneous topics", since it covers independent topics. A couple of topics has been moved from the previous basic tutorial to this one.
  • The structure of the tutorial tests has changed drastically as well. They are not sharing a common resources folder anymore, but each example is in general in its own folder. Also, no more generic names for the tutorial example files are used.
  • The rest of the documentation was adapted and further improved where needed.
  • The CI is also adjusted in regards to the tutorial examples.

Closes #1158.
Fixes #986.

Vasileios Karakasis added 4 commits July 4, 2020 00:42
WIP: Renew the tutorial
e722799
Renew the tutorial
f87ce8b 
- The basic tutorial is rewritten. It starts from the vanilla installation of
  ReFrame and ends in porting the tests to a HPC cluster.
- The ex-advanced tutorial is now renamed to "Miscellaneous topics" and it also
  hosts a couple of examples from former basic tutorial.
- The structure and names of the tutorial examples is changed.
  No more generic names are used.
- Other parts of the documentation were fine tuned and updated.
Add configuration for container platforms in tutorial config
349e00e
Update container test
aefeef0
@vkarak vkarak added this to the ReFrame sprint 20.10 milestone Jul 5, 2020
@vkarak vkarak requested review from teojgo and victorusu July 5, 2020 09:23
@vkarak vkarak self-assigned this Jul 5, 2020
@pep8speaks
Copy link

pep8speaks commented Jul 5, 2020 •
edited
Loading

Hello @vkarak, Thank you for updating!

Cheers! There are no PEP8 issues in this Pull Request!Do see the ReFrame Coding Style Guide

Comment last updated at 2020-07-09 15:05:51 UTC

@vkarak vkarak requested a review from ekouts July 5, 2020 09:26
vkarak
vkarak commented Jul 5, 2020
View reviewed changes
@vkarak
Copy link
Contributor Author

vkarak commented Jul 5, 2020

@jenkins-cscs retry daint

ekouts
ekouts approved these changes Jul 6, 2020
View reviewed changes
Copy link
Contributor

@ekouts ekouts left a comment

Choose a reason for hiding this comment

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

In total, it looks good to me. I had some small comments only for typos/wrong syntax.

@codecov-commenter
Copy link

codecov-commenter commented Jul 6, 2020 •
edited
Loading

Codecov Report

Merging #1397 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1397   +/-   ##
=======================================
  Coverage   91.77%   91.77%           
=======================================
  Files          83       83           
  Lines       12708    12708           
=======================================
  Hits        11663    11663           
  Misses       1045     1045
Impacted Files Coverage Δ
reframe/core/pipeline.py 92.89% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 500e4d3...d7f82e6. Read the comment docs.

teojgo
teojgo requested changes Jul 9, 2020
View reviewed changes
@vkarak vkarak merged commit 973d39e into reframe-hpc:master Jul 9, 2020
@vkarak vkarak deleted the docs/renew-tutorial branch July 9, 2020 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ekouts ekouts ekouts approved these changes

@teojgo teojgo teojgo approved these changes

@victorusu victorusu Awaiting requested review from victorusu

Assignees

@vkarak vkarak

Labels

documentation enhancement prio: normal

Projects

None yet

Milestone

ReFrame sprint 20.10

Development

Successfully merging this pull request may close these issues.

Redesign the tutorial Tutorial examples are not generic

5 participants

@vkarak @pep8speaks @codecov-commenter @ekouts @teojgo