Add tutorial

[asmacdo]

Built on #626 which should merge first.

I tested this on typhon. (I had to use podman instead of docker since I am not in the docker group, but it still worked well).

TODO:

• merge Doc friendlyization #626
• workdir add with datalad run
• Explain datalad a little bit, ie the dataset needs to be installed but the data itself does not need to be fetched locally.
• Go into a little more detail about whats happening during run, ie data specified by --input is fetched
• Be more newbie friendly and explain the docker/podman invocation, especially volume mounts.
• do not use abbreviated parameters in the tutorial ie --orc
• fix list spacing
• clarify reproman installation on localhost not remote resource

[gemini-code-assist]

Summary of Changes

Hello @asmacdo, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the user documentation for ReproMan by providing new introductory content and restructuring existing guides. The changes aim to improve the onboarding experience for new users and make it easier to understand ReproMan's capabilities and how to utilize its features for reproducible research.

Highlights

• New Tutorial Added: A comprehensive tutorial for SSH resource workflows has been introduced, guiding users through basic command execution to complex data analysis with DataLad integration.
• Overview Document Created: A new high-level overview document has been added to explain ReproMan's core concepts, purpose, and benefits, improving initial user understanding.
• Documentation Structure Refactored: The overall documentation structure has been reorganized for improved clarity and navigation, including updates to the main index and logical grouping of topics.
• Documentation Format Conversion: Existing reStructuredText documentation for package handling has been converted to Markdown format, and heading levels adjusted for consistency and readability.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds a new tutorial for SSH resource workflows and significantly restructures the documentation. The changes are well-organized and improve the clarity and structure of the docs. The conversion of the package handling document from reStructuredText to Markdown is a good move for design documents.

I've found a couple of minor issues in the new tutorial file, mainly leftover TODO comments that should be addressed to ensure the tutorial is clear and polished for users. My detailed comments are below.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.07%. Comparing base (9555569) to head (120f136).
⚠️ Report is 76 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (9555569) and HEAD (120f136). Click for more details.

HEAD has 1 upload less than BASE

Flag	BASE (9555569)	HEAD (120f136)
	2	1

Additional details and impacted files

@@             Coverage Diff             @@
##           master     #627       +/-   ##
===========================================
- Coverage   88.28%   78.07%   -10.22%     
===========================================
  Files         149      149               
  Lines       13080    12834      -246     
===========================================
- Hits        11548    10020     -1528     
- Misses       1532     2814     +1282     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.