Material page redesign

[DrDrij]

**Comments from @llorracc on PR #7 **

• We should add one more category of "Materials" to encompass the material we have put in the "examples" documentation directory.
  • Maybe just call it "Examples" here
• We should add some simple automatic testing; Mridul knows how to do that.
  • Specifically, we should autotest whether all urls we generate actually still point to something
    • PortfolioBlogPost does not
• If a bit of metadata is missing, would it be easy just not to print that metadata item on the "materials" page (as opposed to printing it as blank)
• I continue to hanker for a system in which the metadata lives with the content, rather than being hand-entered in a MD file.
• "Published" has always been a problematic category, because there are so many things it could mean. See below for a proposal for how to move forward.
• More and more people know what "Binder" is, but I'm guessing it is still a considerable minority of, say, first year PhD students. So, let's relabel the "Launch Binder" button to something like "Live Interactive Version"
• The name of the item in the "materials" list should correspond exactly to the pre-extension filename
  • So, for example, "ChangeLiqConstr.ipynb" is referred to in materials as "Change Liq Constr" with spaces; it should just be ChangeLiqConstr
  • This would make it easier for people to learn how to find files themselves

"Published", "date", etc.

There are various possible things people might want to know about a notebook, each of which might be thought of as being related to "publication" but none of which corresponds exactly to

1. Date it was originally posted ("first commit" if it is a standalone repo)
2. Date of most recent modification ("latest commit" if it is a standalone repo)
3. Reference to original resource (if it is a REMARK based on a published paper, a url/doi for the publication)
   • I see that you've added a "paper_url" metadata item; probably we should just designate this
4. Suggested BibTeX entry for citation of the object
5. BibTeX entry for citation of the original source (if any)

• As always, my strong preference is for this info to be automatically gathered, rather than hand-entered, wherever possible.

• Is there a master template somewhere showing all of the optional metadata items, and valid potential entries for them?

[DrDrij]

@llorracc I will work through your list of feedback.

Today I have attacked:

• launch URL, materials can now launch notebooks directly by using #launch at the end of a URL (eg. https://econ-ark.org/materials/alternative-combos-of-parameter-values/#launch)
• Unifying all the material pages with a "Options for Executing This Notebook" below the description (eg. https://econ-ark.org/materials/bufferstocktheory)

Interested to know your thoughts. Perhaps the details about executing the notebook could be in a modal popup window?

[DrDrij]

@MridulS Could you please explain the automatic testing?

[DrDrij]

@llorracc I've spent some time styling the buttons and adding a help popup. The main button is now "Live Interactive Version".
Next task is to tidy the naming of each material so that they correspond exactly to the pre-extension filename.
Once the filenames are inline I shall look into various dates for materials and potential auto generating data.

[MridulS]

@llorracc @DrDrij regarding the portfolio choice blog post link, it doesn't exist right now as it looks like I forgot to update the link in the econ-ark.org repo when we moved PortfolioChoiceBlogPost as an individual repository under the econ-ark organisation. The blog post is available at https://econ-ark.github.io/PortfolioChoiceBlogPost/PortfolioChoiceBlogPost.html

@DrDrij This also means we need a new category in materials section for blogposts (is_blog) as it needs to link to the html page.

[MridulS]

@DrDrij regarding testing, maybe its possible to catch certain URL created during build time by Jekyll (not too sure about this, I'll need to have a look) and then auto test them for 404 links after a certain time period (maybe once a day) as it will take some time to propagate changes from GitHub pages.

[llorracc]

Great, thanks for the update!

[llorracc]

@DrDrij

In response to your request for feedback above -- I like what you've done with the "options for launching this notebook" but feel that it should somehow be more prominent -- even after I knew it was there somewhere, it took me a little while to relocate it.