econ-ark / econ-ark.org Goto Github PK

This issue covers a review of the JS code used on the website.

• Clear all console errors
• Check for potential XSS attack vulnerabilities

In the portfolio choice blog post, I needed to refer to the CGMPortfolio REMARK, and realized that we do not have a recommended or standardized way that we have identified for people to refer to our material.

I propose that we should add, at the bottom of the "materials" page for each item, a copy-and-pasteable bibtex entry that people could use to make reference to our materials trivial. It should include a link to the material itself, a standardized citekey, and the minimal requirements to compile successfully in a standard LaTeX/bibtex setup.

Something like this:

@techreport{CGMPortfolioREMARK, 
title={Replication of `Consumption and Portfolio Choice over the Life Cycle' by Cocco, Gomes, and Maenhout (2005)}, 
url={https://github.com/econ-ark/REMARK/tree/master/REMARKs/CGMPortfolio}, 
journal={Econ-ARK/REMARK}, 
publisher={Econ-ARK},
author={Velazques-Giraldo, Mateo and Zahn, Matthew}, 
year={2020}, 
month={Mar},
doi={doi}
}

Currently we can either have a link to mybinder notebook or a mybinder dashboard, we should be able to point towards multiple notebooks from one materials page.

Add space for blog posts on the homepage and possibly individual pages for each post.

Via @sbenthall
I've noticed that there's no blog or similar feed of updates on the current website? I wonder if it would be possible to put one in. There are other reasons why we would want to use this (for example, to announce new HARK releases).

(Sorry I posted under the wrong account earlier)

@llorracc has suggested a number of improvements to simplify the Information Architecture (navigation), since release of the updated website design. Ideally, this will bring the content structure of the website closer inline with the content of the Econ-ARK project.

Specifically, we are improving on the v1.0 section layout:

To a proposed new structure:

• HARK
• REMARK
• OTHER

where "OTHER" would take you to the unrestricted search among materials (including DemARKs), while REMARK would take you a list restricted to REMARKs.

The new structure will bring forward the materials library as a global element. Hosting REMARKs and teaching materials that will live in their own respective sections.

The overall aim here is to improve UX and simplify the website navigation for new users, as well as making it easy for our team to share REMARKs and materials.
We will promote the HARK toolkit and highlight REMARKs as the core source for collaborative value and submission.

Tasks (In progress)

• Change homepage featured items/site sections from HARK, DemARK, REMARK to HARK, REMARK, OTHER
• Human readable URLs for sharing and bookmarking (eg. econ-ark.org/materials/REMARKs)

In discussing what we ought to do to make our first blog post (for TFI) "professional", @sbenthall proposed that one such thing would be to make sure that there is a "permanent url" associated with that content.

That seems like a good idea. Actually, I'd take it further, and say that we should figure out how to get a doi (digital object identifier) for such items. And we ought also to investigate what would be necessary to get doi's for our other content, like REMARKs and DemARKs.

In particular, a doi should be among the things that characterize a "first-class" or proper REMARK.

Add space for blog posts on the homepage and possibly individual pages for each post.

Via @sbenthall
I've noticed that there's no blog or similar feed of updates on the current website? I wonder if it would be possible to put one in. There are other reasons why we would want to use this (for example, to announce new HARK releases).

Broken link on: https://econ-ark.org/toolkit#contributing

Correct link: https://hark.readthedocs.io/en/latest/contributing/CONTRIBUTING.html

I recently noticed that the "Team" tab on the Econ-ARK website is slightly outdated. For instance, it does not include me or @alanlujan91 as members of the "core team."

This is by no means urgent, but in my particular case it would be nice to be able to show that I am a team member as I navigate the job market.

We should move toward a system where there is a script that gets run automatically which:

1. Checks whether there are items in REMARK/REMARKs, DemARK/notebooks, or QuARK/notebooks or HARK/examples for which no materials.md file exists
2. Attempts to automatically construct the stub of a materials.md file that will work if some minimal amount of content exists where it should be.
   • We can start with the minimal content simply being the existence of an eponymous Jupyter notebook
   • Later we might add some other requirements
3. Keeps tabs of the content for which the materials.md file has been autogenerated.
   • Along with a list of things that ought to be done to make it into a first-class materials entry

**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?

The tabs on the Materials page are confusing since adding Tags filtering.

Suggestion to remove tabs and promote/highlight the tags filter.

This issue will cover a general reworking of the filtering UI to make it as user friendly as possible.

@MridulS @DrDrij

Looking at the Pandemic materials today, I realized that the "date" field is empty. It would be good if there were an "edit metadata" button that I could have clicked to take me to the place where I could fix that.

https://econ-ark.org/materials without the last forward slash does work.

However, the home page redirects to https://econ-ark.org/materials/ which is a 404.

What I did, if you look at this page https://econ-ark.org/materials/pandemic/, we had access to a private binder hub that would be reliable and faster for a demo. I wanted to make the link work with the button in actions, but figured out that it is algorithmically generated so it would not be easy to just change this one page.

Perhaps a long term solution is to be able to set the binder link in metadata, and if it's not set, the default is to build it algorithmically as in the website.

Thanks @alanlujan91 for pointing out a potential useful feature —

It may be handy to have optional metadata values for temporary binder instances when running workshops etc.

As the current implementation only takes in one dashboard or notebook, #launch will open it directly in the mybinder instance. But we will have the ability to have multiple notebooks/dashboards so we should come up with the logic to deal with that.

This doesn't seem to work now https://econ-ark.org/materials/blanchardpa2019#launch

The existing "Powered by | Econ-ARK" button signifies that the project in question was built using the Econ-ARK tools.

We should also have a separate button that would take the person to the "Materials" page. Maybe there is a better way to label it than "Launch Online Notebook" -- say, "Interactive Notebook" or something.

This is a link to what you would get if you went to, say, https://econ-ark.org/materials/BufferStockTheory; so,

https://github.com/econ-ark/econ-ark.org/materials/BufferStockTheory

For example: econ-ark.org/materials/REMARKs

Iterative improvements such as full text search and tag filtering within the materials library have been useful.

@llorracc has suggested a logical improvement would be to add direct linking to tags and searches. This would be handy for both sharing and bookmarking.

Essentially human readable URL paths and strings for Materials Library search and filtering.

@MridulS
Like for cstwMPC, authors render as

{"family-names"=>"Carroll", "given-names"=>"Christopher D.", "orcid"=>"https://orcid.org/0000-0003-3732-9312"}
{"family-names"=>"Crawley", "given-names"=>"Edmund", "orcid"=>"https://orcid.org"}
{"family-names"=>"Slacalek", "given-names"=>"Jiri", "orcid"=>"https://orcid.org"}
{"family-names"=>"White", "given-names"=>"Matthew N.", "orcid"=>"https://orcid.org"}

Is this a bug, or intended?

I just clicked on a link that I had constructed to launch a DemARK notebook via the https://econ-ark.org/materials API. It worked. But the transition from https://econ-ark.org/materials was so fast that a user might not even notice it. I want there to be enough of a delay that they might process the fact that there is this underlying tool "https://econ-ark.org/" that maybe it would be worth checking out.

So, maybe a 1 second delay before executing the autoforward would be good.

@llorracc Perhaps a small loading animation with the text describing what is going on in the background.

Since adding the 'Edit metadata' link in #57 it would be good for any changes to update immediately on the econ-ark.org website. They are currently set to update once daily.