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

Add playground application #53

Merged
merged 29 commits into from
Jun 7, 2023
Merged

Add playground application #53

merged 29 commits into from
Jun 7, 2023

Conversation

ships
Copy link
Collaborator

@ships ships commented May 10, 2023

Description

This new application is a simple stateless web app that allows you to visualize a docmap based on our Crossref-to-Docmap ETL library.

How to review

Take a gander over at the github pages hosting the app. You can plug in any DOI, and if crossref knows about it and it has reviews or a preprint, you'll get some interesting content back. A good one to start with is 10.5194/angeo-40-247-2022 .

Then glance over the code.

It relies on updates to render-rev that I have submitted via source-data/render-rev#2 . Once that is merged, we can stop using the awkward fork-branch syntax for the new dependency.

It also relies on changes to the ts-etl package which are included in this PR. they should be released together automatically by multi-semantic-release.

Note that because the SPA is so minimal in logic it doesn't currently have lint or tests.

Related Issues

Resolves #45
Mutual with #15
Depends on #42

Checklist

  • I have tested these changes locally and they work as expected.
  • I have added or updated tests to cover any new functionality or bug fixes.
  • I have updated the documentation to reflect any changes or additions to the project.
  • I have followed the project's code of conduct and conventions for commit messages.

Additional Information

Implemented using Svelte.

@ships ships force-pushed the ships/chore/add-playground branch from 529855d to 52e9ca1 Compare May 11, 2023 18:03
@ships ships force-pushed the ships/chore/add-playground branch from 52e9ca1 to 7b6b510 Compare May 30, 2023 18:10
@ships ships temporarily deployed to github-pages June 1, 2023 18:35 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 1, 2023 18:36 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 1, 2023 18:41 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 1, 2023 19:54 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 1, 2023 20:15 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 1, 2023 20:40 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 1, 2023 22:18 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 1, 2023 22:34 — with GitHub Actions Inactive
@ships ships changed the title [WIP] Adds playground application Add playground application Jun 1, 2023
@ships ships requested a review from gabestein June 1, 2023 22:57
@ships
Copy link
Collaborator Author

ships commented Jun 6, 2023

@gabestein and @sheishistoric , feedback was that looking up docmap by DOI of a review object should produce docmap for the preprint it reviews. However, I'm realizing that we had decided something different last time we talked about that: see discussion on #49 and #48 . I am inclined to let the precedent stand, which means to pull this in without handling the "look up by review" case.

But I should fix the erroring behavior now, by essentially saying "we can't construct a docmap for this item, because it is a review; look up the preprint instead." maybe with helpful link.

I think that would make the SPA's behavior clear and coherent enough when user attempts this, without the complexity increase that we would pick up with #48 . Alternatively, we could change the desired behavior in #49 so that it returns a full docmap for the preprint; or implement that as an interim behavior expecting it to change (my least favorite of the options.)

@ships ships temporarily deployed to github-pages June 6, 2023 22:58 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 6, 2023 23:16 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 6, 2023 23:27 — with GitHub Actions Inactive
@ships ships temporarily deployed to github-pages June 6, 2023 23:40 — with GitHub Actions Inactive
Copy link

@3mcd 3mcd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ships ships temporarily deployed to github-pages June 7, 2023 17:51 — with GitHub Actions Inactive
@ships ships merged commit 7af9d2d into main Jun 7, 2023
@ships ships deleted the ships/chore/add-playground branch August 22, 2023 17:46
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

Successfully merging this pull request may close these issues.

[new]: Playground / interactive explorer and creator
2 participants