Page MenuHomePhabricator

Render markdown / rst in PAWS public
Open, MediumPublic

Description

Files uploaded to PAWS servers with .md / .rst extension should be parsed and rendered as HTML. Currently, .ipynb files are fully rendered, but .md and .rst files displayed as plain text.

This would need to be accomplished in https://github.com/toolforge/paws/blob/master/images/renderer/renderer.py or similar where paws-public URLs are rendered.

Event Timeline

Chicocvenancio triaged this task as Medium priority.Feb 25 2018, 9:22 PM
Chicocvenancio moved this task from Backlog to Easy tasks on the PAWS board.
srishakatux changed the visibility from "Public (No Login Required)" to "Outreachy Mentors (Project)".Feb 26 2020, 9:17 PM
srishakatux added a subscriber: srishakatux.

(we'll open this task on March 5th - when the contribution period opens)

srishakatux changed the visibility from "Outreachy Mentors (Project)" to "Public (No Login Required)".Mar 5 2020, 6:24 PM

So here, we wish to create a function that renders .md / .rst files into HTML. Then, we need to map the extension with the required render function call in the "handlers" dictionary. Am I correct?

I'd like to work on this one! Could you please assign it to me?

Hey! I want to start working on this project, I hope it's not too late! I checked the GitHub repo and there seems to be no PRs against this issue. Can I take it up?

Hello @Aashnajena, this task is already assigned, but you could try to collaborate with @Karma2902 on it if they start working on it.

If anyone submits a PR, we can review it and work with it either way. If one PR comes in to add this functionality, someone else could do a PR to improve the code as well.

In this case, it needs to be a change in both the code and the renderer docker image as well if you need a new library that isn't in the standard install for python here https://github.com/toolforge/paws/blob/master/images/renderer/Dockerfile.

If you use the method in the links, you'll need to install the markdown and docutils libraries in the image before using it in the code. You can experiment with that by building the image locally and trying changes to the Dockerfile.

Hi @Bstorm , I made a PR regarding the issue.

Hi @Bstorm , I made a PR regarding the issue.

Thanks!! Really appreciated.

I just reviewed it in github, please see my comments and get back to us for any questions.

Hello @aborrero ! Could you please check the Zulip private chat? It's with regards to the final application.

Hello @aborrero ! Could you please check the Zulip private chat? It's with regards to the final application.

I believe I already replied :-) Feel free to contact if you have more questions.

I'll leave here my email too in case you need it: aborrero@wikimedia.org (although I recv zulip PMs in email anyway)

Okay, thank you so much! :D

bd808 removed Karma2902 as the assignee of this task.Aug 12 2020, 10:12 PM
bd808 added a subscriber: bd808.

Removing claim on task. @Karma2902 has no activity on the associated pull request or here on Phabricator since April 2020.