search

openedx / openedx-atlas

An Open edX CLI tool for moving translation files from openedx-translations
GNU Affero General Public License v3.0
3 stars 7 forks source link

npm package missing readme #39

Open brian-smith-tcril opened 1 year ago

brian-smith-tcril commented 1 year ago

image

brian-smith-tcril commented 1 year ago

From what I've read it seems like npm might not support .rst readmes. Maybe we can generate a .md that links to the GH repo?

OmarIthawi commented 1 year ago

I think it's a package.json configuration issue. I'll publish to pypi and get back to this.

OmarIthawi commented 1 year ago

@brian-smith-tcril Based on my quick research, it looks like that npm doesn't support RST at all, while PyPi appears to support both RST and Markdown:

Popular packages such as React.js use Markdown: https://www.npmjs.com/package/react

Some Open edX packages uses Markdown as well such https://www.npmjs.com/package/@edx/paragon while others don't as you pointed out for frontend-build.

We have a couple of options:

  1. Use Markdown on all Open edX Nodej.s packages
  2. Use Placeholder README (my least favorite)
  3. Convert to Markdown on the fly (adds yet one more build step)

I'm leaning towards using Markdown at least until npmjs has support for RST.

brian-smith-tcril commented 1 year ago

@OmarIthawi would you mind adding that comment to https://github.com/openedx/public-engineering/issues/215 ? I brought this up in standup yesterday and people seemed to be OK with the placeholder idea, but I'm more than happy to re-open the discussion.