search

mitodl / ocw-to-hugo

A command line utility for taking master.json output from ocw-data-parser and producing markdown for use with hugo-course-publisher
3 stars 0 forks source link

embedded GNU makefile documentation causing issues #468

Open gumaerc opened 4 years ago

gumaerc commented 4 years ago

Not using the template for this, as it's not really causing any breaking bugs right now but it still needs to be documented.

https://ocw.mit.edu/courses/civil-and-environmental-engineering/1-124j-foundations-of-software-engineering-fall-2000/lecture-notes/gnu_makefile_documentation/

The above page in OCW is just a copy-pasted clone of an older version of this page:

https://www.gnu.org/software/make/manual/make.html

We should link to this content externally rather than just embedding the HTML within OCW. This will ensure people browsing OCW always see the latest version of it and also prevent introducing special snowflake HTML into ocw-to-hugo.

pdpinch commented 4 years ago

@gumaerc did you say you had a PR for this?

gumaerc commented 4 years ago

@pdpinch I was recommending that we actually fix this upstream, have the OCW team change this course so that instead of copy / pasting in the HTML of the GNU Makefile documentation they just link to it directly on the gnu.org site.