helpers icon indicating copy to clipboard operation
helpers copied to clipboard

Convert VeraCrypt gdoc to Markdown

Open sonniki opened this issue 9 months ago • 1 comments

We have a gdoc on VeraCrypt here: https://docs.google.com/document/d/1IVH3d1QSa2ZwEA0I8WaED1MeoVnaqDNMJY-Ko9Eg-Ss/edit?tab=t.0#heading=h.8pu3znkowk72

We want to convert it into a Markdown in our docs/ dir. Instructions here should be helpful. There is also this script that you can use although be careful and double-check the output, there might be corner cases that are not handled properly.

sonniki avatar Mar 03 '25 11:03 sonniki

FYI @gpsaggese

sonniki avatar Mar 03 '25 11:03 sonniki

@Peeyush4 if you don't have access to the gdoc, let us know and @gpsaggese will provide it

sonniki avatar Apr 03 '25 21:04 sonniki

There is also this script that you can use although be careful and double-check the output, there might be corner cases that are not handled properly.

I realized now that the script will probably not work for interns since it uses dockerized pandoc. But it shouldn't be too much hassle to do it without the script either.

sonniki avatar Apr 03 '25 21:04 sonniki

I do not have access to the google docs.

Peeyush4 avatar Apr 04 '25 00:04 Peeyush4

@Peeyush4 I've shared the VeraCrypt doc with you and updated the link in the starting post

sonniki avatar Apr 07 '25 19:04 sonniki

  1. What should I name the file? how_to_use_veracrypt.md?
  2. Which subfolder inside the docs/ dir should I store it in?

Peeyush4 avatar Apr 07 '25 23:04 Peeyush4

  1. What should I name the file? how_to_use_veracrypt.md?

    1. Which subfolder inside the docs/ dir should I store it in?

@Peeyush4 please browse files in docs/ and come up with a proposal regarding both questions yourself, based on what you infer from the existing documentation. Feel free to file a PR when ready, and we can review what you come up with. Independence in solving questions like these ones is one of the criteria on which we grade interns.

sonniki avatar Apr 08 '25 08:04 sonniki

@Peeyush4 many times the answer is just around. Our rule of thumb is that when someone asks a question, they should also provide a possible response to show that they have done the work.

gpsaggese avatar Apr 08 '25 13:04 gpsaggese

Done

sonniki avatar Apr 10 '25 19:04 sonniki