taskManeage - Tasks: task #15591, Tutorials for the beginner and...


You are not allowed to post comments on this tracker with your current authentication level.

task #15591: Tutorials for the beginner and intermediate user

Submitter:  Raul Infante-Sainz <infantesainz>
Submitted:  Wed 08 Apr 2020 10:02:34 PM UTC
Should Start On:  Wed 08 Apr 2020 12:00:00 AM UTC Should be Finished on:  Wed 08 Apr 2020 12:00:00 AM UTC
Category:  Webpage Priority:  5 - Normal
Status:  None Privacy:  Public
Percent Complete:  20% Assigned to:  None
Open/Closed:  Open Effort:  0.00

( Jump to the original submission )

Wed 23 Jun 2021 11:20:18 PM UTC, comment #7: 

Thanks for raising this issue Boud.

Since the main job (a tutorial) is done (for an advanced user), I changed the title to "Tutorials for the beginner and intermediate user".

About the formatting of the Maneage documentation, we are already planning to use Texinfo in task #15825. So let's not waste time trying to convert Markdown ;-).

I should get that task started as soon as possible! There are just too many things to do :-(. If anyone would like to volunteer for that task, please take the lead ;-).

Mohammad Akhlaghi <makhlaghi>
Project Administrator
Tue 22 Jun 2021 04:22:54 PM UTC, comment #6: 

This wasn't in the repository before. But just now I pushed  commit 31e38ea2b2 on my gitlab repository that contains the md2html.bash and a github-ish style. There is more detail in the scripts about the source :) Please let me know if you have any questions.

You can run the script and feed the filename as an argument. For example:

./md2html.bash README.md

This will produce a 'README.html' output with correct HTML head and body tags.

Pedram Ashofteh-Ardakani <pedram>
Project Member
Tue 22 Jun 2021 03:35:19 PM UTC, comment #5: 

hi Pedram! Is this source in one of the git repositories? I'm not volunteering to do any tutorials on any short time scale, and I don't really mind either markdown + hacking or direct html, but this would be useful to know for anyone willing and finding time to do the work. :)

Boud Roukema <boud>
Project Member
Tue 22 Jun 2021 03:11:04 PM UTC, comment #4: 

Hi, the markup to HTML conversion was semi-automatic, using this script. Semi-automatic, because it failed to recognize some styles. Maybe we can use other more accurate scripts, and update the HTML automatically :)

Pedram Ashofteh-Ardakani <pedram>
Project Member
Tue 22 Jun 2021 02:59:20 PM UTC, comment #3: 

Following an idea by Mohammadreza, having a very short minimal tutorial would be good.

The current 'tutorial' link in the top bar would be good with a pull-down menu for 'beginner', 'intermediate' and 'advanced' tutorials.

Boud Roukema <boud>
Project Member
Tue 22 Jun 2021 02:53:49 PM UTC, comment #2: 

Just to update this. We have had a tutorial in place at https://maneage.org/tutorial.html for quite some time now.

The git repository for the source is currently https://gitlab.com/maneage/webpage/-/blob/master/tutorial.html . (I don't remember if this is generated automatically or not from a non-html source?)

Boud Roukema <boud>
Project Member
Wed 22 Apr 2020 07:29:36 PM UTC, comment #1: 

Indeed, this is quite nice! Providing clear and extensive documentation to train non-experienced users is critical for promoting software.

Here is one of the simple and effective documentations which I really like, simple, clear, and informative. I hope you too find it useful: https://www.perltutorial.org/

Pedram Ashofteh-Ardakani <pedram>
Project Member
Wed 08 Apr 2020 10:02:34 PM UTC, original submission:  

It would be nice to have some tutorials with different level of difficult in order to show how to use Maneage in practice. For example, a very first basic tutorial explaining how Make works with very basic examples. Second tutorial showing how to include Makefiles and make an small analysis of a dataset in Maneage. Finally, a third tutorial a bit more difficult showing how to deal with multiple files using Makefile pattern match (for parallelizing). This is just ideas that are in my mind but it is open to be discussed.

The second tutorial is almost done and it is waiting to be corrected/improved. It consists in making an easy analysis (linear fitting of a dataset) to show the workflow in Maneage. It is available in my fork: https://gitlab.com/infantesainz/reproduce-raulfork/-/tree/tutorial

Raul Infante-Sainz <infantesainz>
Project Member


(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

No files currently attached


Depends on the following items: None found

Items that depend on this one: None found


Carbon-Copy List
  • -email is unavailable- added by makhlaghi (Posted a comment)
  • -email is unavailable- added by boud (Posted a comment)
  • -email is unavailable- added by pedram (Posted a comment)
  • -email is unavailable- added by infantesainz (Submitted the item)

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.




    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-06-23 makhlaghi Percent Complete0% 20%
        SummaryTutorial to show step by step how to use Maneage Tutorials for the beginner and intermediate user
    2021-06-22 boud CategoryNone Webpage

    Back to the top

    Powered by Savane 3.11