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

Create a project output viewer #385

Closed
sebbacon opened this issue Feb 7, 2021 · 4 comments
Closed

Create a project output viewer #385

sebbacon opened this issue Feb 7, 2021 · 4 comments

Comments

@sebbacon
Copy link
Contributor

sebbacon commented Feb 7, 2021

While github will remain the canonical source, the Job Server should become the preferred place for people to view final project outputs, as it gives us an opportunity to add a number of usability enhancements.

Most importantly, redacted & released outputs can be rendered in a nice viewer. At the time of writing, Github is an adequate viewer, but we are likely to be moving to storing released outputs outside the git repo, as for IG reasons we don't want them to be versioned.

This means we'll want a way of rendering jupyter notebooks, markdown, HTML, and images nicely, inline. For example, we've discussed storing released outputs as build artefacts in Github releases. Our viewer would proxy to those for the source of its content.

The viewer would use as its manifest the files specified in a final publish action in the project pipeline.

It would use Github Release Versions to allow users to select historic outputs, although the default would always be the latest.

Longer term, we can imagine that papers etc might link to the "project" page in the job server, rather than directly to Github. This might have a nice landing page that collects together the project overview, links to publications, links to codelists, links to IG approvals, and versioned outputs.

@sebbacon
Copy link
Contributor Author

We've also discussed an opensafely fetchdata subcommand for grabbing data for local development etc

@ghickman
Copy link
Contributor

@sebbacon – is this superseded by the reports app now?

@sebbacon
Copy link
Contributor Author

No. The Reports app is for a curated subset of all outputs, which are always in HTML (usually Jupyter Notebooks).

There will be some code (e.g. look and feel) in common, though

@ghickman
Copy link
Contributor

Done as part of the outputs voyage!

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

No branches or pull requests

2 participants