Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Static page markdown transfer #53

Closed
jameslzhu opened this issue Mar 18, 2019 · 1 comment
Closed

Static page markdown transfer #53

jameslzhu opened this issue Mar 18, 2019 · 1 comment

Comments

@jameslzhu
Copy link
Member

jameslzhu commented Mar 18, 2019

Pull request #15 added markdown pages: static pages (with no dynamic js content), which can be created and edited by regular users in Markdown. (You may be more familiar with Github Flavored Markdown). If you've ever written a comment on Reddit, Stack Overflow, or Github, chances are you've unwittingly been using Markdown.

Many of the pages on the old site are either hard-coded in HTML or uploaded under our static page feature in HTML. This project will entail converting these pages to simplified Markdown text, so we can re-upload these in the new website.

You can do this either manually or automatically with cleanup; a quick search on doing this task with pandoc suggested this stack overflow link with the following snippet:

pandoc -f html -t commonmark myfile.html >myfile.md

As for the exact pages to convert, you'll have to hunt them down on the current website (hkn.eecs.berkeley.edu). I've found a few examples below:

Of note, if you'd like to rewrite these pages, you should definitely check first with the corresponding committee - simpler is better, but not if it omits important information. Also, in some cases these committees may want the extra formatting HTML can offer.

We'll give you compserv permissions on the site for you to access the copy-paste HTML, without the header / footer cruft.

If you take on this task, you should ask us to add you to the org so you can access the old hkn-rails site and the html files.

Of note, these will eventually need to be stored as text fields in the database. (This functionality is already implemented in the markdown-pages app.) But since we don't have a stable database / backups, we won't be uploading these to the SQL database in the OCF apphost, but instead saving these text files in the Github somewhere for the time being. (Preferably somewhere sensible like hknweb/static/md, but idk.)

@bri25yu
Copy link
Contributor

bri25yu commented Apr 13, 2022

Combining with #432

@bri25yu bri25yu closed this as completed Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants