hyperledger-labs/university-course

migrate .tex files to markdown

Opened this issue · 9 comments

As pointed out by @shoebsd31 #38

Hi, I am Khushi Chaudhary, a contributor to OpenForce 2022. I would like to work on this issue. I would be making a PR as soon as I am done with resolving the issue. Thank you

Hello @RafaelAPB, I have checked this issue and able to complete ASAP. Can you please assign this issue to me ? This would be my first contribution as a beginner to hyperledger so I want to start it with a issue related to documentation.

@KhushiChaudhary744 and @sheetalj2205 in which files will you be working? We should try to divide in order to prevent duplication

Hello @RafaelAPB, thanks for replying. I think I can migrate .tex files for folder Lab-01 to Lab-04 and rest of the files can be done by @KhushiChaudhary744 . Will this be fine?

For me the contributing steps would be:

  1. Fork the repository and clone it.
  2. Create a new branch with name "new-feature[issue-number]"
  3. Go in the university-course/source/Lab01/Guide/ and university-course/source/Lab01/Instructors Guide folder then create assignment.md file which is the conversion of assignment.tex file .
  4. Repeat step 3 for other folders like Lab02, Lab03 etc.
  5. Commit changes and make a PR.

@RafaelAPB Please inform me whether I am on right track or not?

I have one doubt about: Do I need to delete assignment.tex files from all folders or not?

@sheetalj2205 for me yes! It's a first come first served basis :)
Exactly, those are the right steps. I think we can keep both versions at this point. So for example, you could create a folder Lab01-md for your translated files.

You can easily visualize and analyse the .tex files using Overleaf (overleaf.com) and visualize your markdown using https://markdownlivepreview.com/
Please let me know if you need some help!

Hey @RafaelAPB
Is this issue is still open? I want to work on this if anything is left.

Hello @sheetalj2205. Yes!

Hello @sheetalj2205. Yes!

okay, I'll complete this soon