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

Feedback from JOSS review #139

Merged
merged 66 commits into from
Feb 28, 2023
Merged

Feedback from JOSS review #139

merged 66 commits into from
Feb 28, 2023

Conversation

stsievert
Copy link
Owner

@stsievert stsievert commented Jul 8, 2022

What does this PR implement?
It implements some changes in the JOSS paper review at openjournals/joss-reviews#4517

Frontend:

  • allows some HTML/JS customization (and provides examples)
  • Has better documentation around frontend customization and deploying. Shows examples, and mentions on tips 'n tricks I've learned (at /frontend/)

Backend:

  • Allow offline to work with only minimal pip install

Documentation:

  • explain how crowdsourcing screens can be customized
  • offline install documentation improved.
  • clean up install docs (python fixed, prefer conda, etc)
  • Adds note about running Salmon in docker machine (only meant for devs).
  • check licenses more closely to make sure compatible (and adds note about licenses to docs)
  • hosts documentation on GitHub (as PDF and zipped HTML directory)
  • changes license to Apache BSD 3 (from MIT) (and adds note setup.py)
  • cleaned up the offline example code

Small improvements:

  • more stable version install with salmon.lock.yml
  • Removes starellete-prom (because it's has an incompatible license)

Reference issues/PRs

@stsievert stsievert mentioned this pull request Jul 8, 2022
1 task
@stsievert stsievert mentioned this pull request Jul 31, 2022
1 task
@stsievert
Copy link
Owner Author

stsievert commented Dec 5, 2022

What does this PR perform?

  • Makes documentation more accessible (PDF, HTML directory)
  • Makes install more stable (pins versions, cleans up documentation for developers)
  • Adds documentation page on customizing the frontend
  • Changes license to BSD License
  • Adds documentation page on deploying
  • Adds dependencies and their licenses.
  • Replaces starlette_prometheus with starlette_exporter
  • Includes custom HTML for the top, middle and bottom, and custom JS too.
  • Links to Salmon's license from the doc page

We have two copies of documentation on deploying. Resolved; now getting-started.html links to the deploying docs.

@stsievert stsievert merged commit 452ac94 into master Feb 28, 2023
@stsievert
Copy link
Owner Author

Merging to update master. (of course will probably be more feedback from the JOSS review)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant