quantecon / bookshelf Goto Github PK

Right now the tags are a static list of checkboxes that users can toggle for the submission. This seems somewhat restrictive to me, especially if we get traction or usage from outside the economics community.

I think the stack overflow model of tags is excellent. The main points are:

• A finite list of tags are avaialbe
• New tags can be proposed by "trusted" community members.
• When you make a new post the tag field is a search box that offers auto-completion suggestions for existing tags.

I think it might be worth adding beta test link to forum on the front page alongside the email me.

When a user tries to authenticate via Twitter, the user is authenticated in the popup rather than the app. This seems to be isolated to adding Twitter to an existing account

It would be good to get visual feedback that profile changes have been saved.

Add in an Admin Page for Admin type users that will allow:

• assign submission to another user
• edit a users submission (i.e. to remove offensive material etc.)
• delete a user from the database
• assign another user as an admin (max 5)
• add an indicator that the logged in user is an admin

the goal is to make administering the site easier with web driven admin utilities.

The website is not rendering the LaTeX using mathjax. Can this javascript extension be added?

Some lightweight documentation needs to be written for the project.

• setup server and aws environment
• configuration and management options of the site
• setup node server (contents from README.md)

This doesn't have to happen straight away but it would be nice to identify the best technology used to support this documentation javadoc for javascript etc.

The QuantEcon banner is not rendering properly

Time filter for today is too strict and should be relaxed to show content on website

We should add highlighting for as many languages as possible I think

Example: Chase's notebook using MATLAB

http://bookshelf.quantecon.org/submission/5a00769761780b3e9574d8a5

@jstac could you update the name of this repository from QuantEconLib to Bookshelf

Also everyone may need to reclone or reset their ORIGIN config.
Push will still work but will trigger a redirect warning.

We need something on that front page that gives a brief summary of what QuantEconLib is.

We should also note that it is part of the QuantEcon organisation and is funded by the Sloan Foundation (with their respective logos)

Allow the Forum (Bookshelf) site to be driven by a theme:

• develop a quantecon theme
• develop a basic theme that can be released when we open source the underlying react tools for setting up your own forum for other projects.

We should have a unique logo for QELib in the top-left hand corner, and get rid of the QuantEcon logo in the middle (I personally think the menu bar will suffice)

@DrDrij any thoughts?

Feedback from jupytercon poster session.

This would probably require supplementary mentioned in #11, but it would be cool if we allowed users to specify a python/julia/other config for their notebook so we could have an "open in binder" button that launches an executable version of the notebook.

I view this as a bit orthogonal to or perhaps outside the scope of the project, but I put it up here so others can share their comments.

CodeMirror is used in the NotebookPreview to style the notebook. The website's main app.css file also sets some of the CodeMirror styles which causes the preferred nteract/custom styles to become overwritten with the main app.css

The main app.css needs to be re-written so that it either doesn't clash with nteract's styling, or defines the style correctly itself.

Migrate to smaller t2 instance to run the live site and monitor performance of server. t2 have burstable cpu_credits and is typically good for running web-sites etc.

• migrate to t2.medium
• close current large scale instances running in Oregon
• setup a staging instance for testing and attach to staging-bookshelf.quantecon.org in route53

http://bookshelf.quantecon.org/submission/59fa1cb6145fc3772b0cef83

Can we change the URL ASAP?

I'm proposing qelib.quantecon.org

I think the OAUTH still comes up with QEtest or something as well.

@tlyon3 I know you're across this but I couldn't find an issue for tracking / comments etc.

The current implementation is slow to render some notebook files that are of moderate size. Possible sources for this performance issue:

• react rendering time locally in the browser
• aws instance and network access

@tlyon3 given the computing is happening in the browser (at the client) should we be measuring performance using a tool like selenium?

I get tricked by having to click Preview on the main submission page and then Submit on the preview page in order to submit a notebook.

I think the 1st best would be to have a preview of the notebook automatically pop up when the notebook file is added on the submission page. I would then place the submit button above this live preview, so users don't have to scroll to the bottom of their (potentially long) notebook to find the button. For most of my notebooks I can tell if I have the right one from the very top of the notebook where I usually include a title/summary of the contents.

it might be nice to get an email saying that the notebook has been published on the forum with a summary of the form details when users submit?

We might be able to use our mailgun account for email dispatch from the server

Is this summary text formatting just a case of poor user input?
Or is there a way we can make this look better through rendering.

note please ignore my green tint.

Feedback from jupytercon poster session.

Being able to submit a notebook by "pairing" to a github gist or to a path within a github repo would be great. It would be even better if this feature used the github api to check for updates to the notebook file and automatically rendered the latest version (perhaps on a specific branch) of the notebook when other users view the submission.

Any MathJax in a submission summary will only render if the user reloads the page. It should be rendering automatically when the page first loads

When a user deletes their account, their submissions and comments will still be visible. We need to add this line to the Terms of Service.

Should the name of the author be replaced with [deleted] or just leave their name in?

it would be great to have the small QuantEcon logo in the tab next to QuantEconLib. Currently it has a file logo.

High Priority:

• Admin options/users
• Notification system
• Set up a Docker container for project
• Co-Authors
• Comment/Reply deletion?
• Search by author name as well

Lower priority:

• Voting on comments and replies
• Style loading screens
• Implement view count
• Implement "Trending" algorithm
• Registration page
• Warn users when leaving Edit Profile page if their are changes
• Implement more robust error handling
• Refactor and document code
• Migrate OAuth credentials to QuantEcon dev profiles

Suggestions:

• Organization users

All submissions are shown on the user page rather than just that user's submissions.

We still only have placeholder text for the ToS

@mmcky did you ever write to the legal team at NumFOCUS?

Rendered HTML is being sanitized and removing important/needed JS. Need to figure out a way to balance security and functionality.

Incorporate the new logo that has been developed by @DrDrij.

Prepare and release the project as an open source forum for communities focused on using Jupyter Notebooks.

It would also be nice if pressing 'back' kept the same filter settings rather than going back to default (I don't know how hard that is though)

Here are a few resources that might be useful for testing the bookshelf project

Library that enables one to simulate user behaviour for load testing:
https://locust.io/

It would be great to have an FAQ to answer technical questions, etc.

This is feedback from the poster session.

It would be great if we could do what nbviewer does and support submitting a notebook from a url. I could see myself using this by publishing a specific commit of a notebook in a GH repo.

One feature request I have been asked for is notifications for comments.

It would be a killer feature if we can index/search on the contents of the notebook.

I think it makes sense to restrict the index to just the input cells, as the output cells can have lots of junk in them (e.g. base64 png images).

Even with that restriction, I'm not sure this is feasible if the site grows, but if we could pull it off that would be great.

Could we please update the categories to the following:

Agricultural Economics
Business Economics
Computational Economics
Computational Techniques
Economic Development
Economic History
Economics of Education
Economics of Law
Environmental Economics
Financial Economics
Game Theory
General Economics and Teaching
Health Economics
Industrial Organization
International Economics
Labor Economics
Macroeconomics
Mathematical/Quantitative Methods
Microeconomics
Monetary Economics
Public Economics
Other

If you edit a submission the previously selected topic boxes are not checked.

If you check them again you duplicate the topics and they show up double when you go back to view the submission after submitting the edit

We should allow users to submit supplementary files when they upload a notebook. Possible uses are to upload data or code referenced in the notebook

Trying to edit any submission and replacing the notebook doesn't actually cause the notebook to be updated

After submitting a reply to a comment using github login credentials, and writing a reply to my own comment I get returned a blank screen. When refresh the page -- the comment has been added.

Note: this only happens to me on the first reply. Using chrome.

Right now, clicking on Markdown will direct the user to a new page. Then when the user goes back, all fields in the submission form are reset. Using a modal to show a quick reference guide for Markdown would avoid this problem.

When I tried editing a comment -- the updates are not added after pushing submit

@tlyon3 I think the best option is to change QuantEconLib to QuantEconLib (beta)

https://github.com/nteract/vdom