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

[doc] Revamp the documentation #3095

Merged
merged 23 commits into from
Apr 20, 2024
Merged

Conversation

vkarak
Copy link
Contributor

@vkarak vkarak commented Jan 17, 2024

The documentation is almost entirely rewritten and updated. Key features:

  • All individual small tutorials are replaced by a single central tutorial + how to articles
  • New topics are covered and older, less relevant topics, are toned down or removed.
  • All of the tutorial and how to examples now run inside Docker containers

Todos

Closes #2636.

Copy link

codecov bot commented Jan 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.67%. Comparing base (a278d9a) to head (9607459).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3095   +/-   ##
========================================
  Coverage    86.67%   86.67%           
========================================
  Files           61       61           
  Lines        12139    12139           
========================================
  Hits         10521    10521           
  Misses        1618     1618           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@vkarak vkarak force-pushed the doc/new-tutorial branch 3 times, most recently from 288102a to ceefd02 Compare February 6, 2024 22:41
@vkarak vkarak changed the base branch from master to develop February 6, 2024 22:42
@pep8speaks
Copy link

pep8speaks commented Feb 14, 2024

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 2024-04-20 16:45:35 UTC

@vkarak vkarak force-pushed the doc/new-tutorial branch 2 times, most recently from 45ff1a6 to 8a961f6 Compare February 22, 2024 14:30
@vkarak vkarak force-pushed the doc/new-tutorial branch 2 times, most recently from 3ce8427 to 5bd96bc Compare March 3, 2024 22:18
@vkarak vkarak closed this Mar 4, 2024
@vkarak vkarak reopened this Mar 4, 2024
@vkarak vkarak force-pushed the doc/new-tutorial branch 3 times, most recently from 65df49a to 72ed2e4 Compare March 12, 2024 22:36
@vkarak vkarak force-pushed the doc/new-tutorial branch 2 times, most recently from 2637ec7 to 5598136 Compare March 26, 2024 22:29
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/config_reference.rst Outdated Show resolved Hide resolved
docs/started.rst Outdated Show resolved Hide resolved
docs/started.rst Outdated Show resolved Hide resolved
docs/started.rst Outdated Show resolved Hide resolved
docs/howto.rst Show resolved Hide resolved
docs/howto.rst Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Show resolved Hide resolved
Copy link
Contributor

@teojgo teojgo left a comment

Choose a reason for hiding this comment

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

I am nearly finished, only the howto remains.

docs/tutorial.rst Show resolved Hide resolved
docs/tutorial.rst Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/howto.rst Outdated Show resolved Hide resolved
docs/howto.rst Outdated Show resolved Hide resolved
docs/howto.rst Outdated Show resolved Hide resolved
docs/howto.rst Show resolved Hide resolved
docs/howto.rst Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
vkarak and others added 5 commits April 18, 2024 23:46
Co-authored-by: Theofilos Manitaras <manitaras@cscs.ch>
Co-authored-by: Jack Morrison <32687739+jack-morrison@users.noreply.github.com>
docs/tutorial.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Show resolved Hide resolved
docs/tutorial.rst Show resolved Hide resolved
@vkarak vkarak changed the title Revamp the documentation [doc] Revamp the documentation Apr 19, 2024
@vkarak vkarak merged commit 8a144c9 into reframe-hpc:develop Apr 20, 2024
25 checks passed
@vkarak vkarak deleted the doc/new-tutorial branch April 20, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Refresh the basic tutorial
6 participants