Update the releasing-files section #1594
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
rebkwok
commented
Aug 13, 2024
rebkwok
commented
- moves releasing docs to a subfolder and updates relevant links
- Splits out the information about requesting release of files (allowed filetypes, advisory notes to request when final etc) from instructions on the process itself
- Links to Airlock docs as the primary process for requesting release
- Moves the old process to a secondary page (still linked, but noted as deprecated)
- Some updates to the overview page
- Removes the section on viewing unreleased outputs from the job-server page, and replaces with a link to Airlock docs
rebkwok
force-pushed
the
output-checking
branch
from
d3b54ee to
7c304f7
Compare
Deploying opensafely-docs with
|
| Latest commit: |
8785e25
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://82d5523c.opensafely-docs.pages.dev |
| Branch Preview URL: | https://output-checking.opensafely-docs.pages.dev |
LFISHER7
reviewed
Aug 15, 2024
rebkwok
force-pushed
the
output-checking
branch
from
3323585 to
0ad8204
Compare
rebkwok
force-pushed
the
output-checking
branch
from
0ad8204 to
1015ef7
Compare
This means we can link to the overview page at the section root instead of having to click on the root to open the dropdown, and then on the overview link.
This page wasn't very easy to read.This makes it reiterate the 5 safes instead of just linking back, and splits out the 4 activities into more clearly separated sections.
Split the information (about allowed file types etc) about releasing files into a separate page to the specific process instructions. This means we can link to the Airlock docs for the process, and also include a link to the old process in case it's needed.
Removes some docs that were specific to the old process, but otherwise mostly unchanged.
This page was not about actually releasing the files, but about viewing those released files on job-server.
Update links to releasing section, plus driveby fix to change absolute links to other docs pages to relative links.
rebkwok
force-pushed
the
output-checking
branch
from
1015ef7 to
8785e25
Compare
bloodearnest
approved these changes
Aug 29, 2024
There was a problem hiding this comment.
This looks good, and is great to see the old stuff go away.
I have a suggestion about organisation. Much of the focus here is on releasing outputs. However, the very first thing users will want to do is look at at outputs, before they ever get to releasing.
As such, I wonder if this menu structure:
- Releasing research outputs
- Applying statistical disclosure control
- Requesting release of research outputs
- Review process for release requests
- Viewing released outputs
- Releasing with Airlock >
could possibly restructure/renamed, possibly with a new section, something like:
- Viewing and Releasing Outputs
- Viewing outputs with Airlock
- Applying statistical disclosure control
- Requesting release of research outputs
- Review process for release requests
- Viewing released outputs
- Viewing and Releasing with Airlock >
The new section would mostly be pointers to airlock docs, but it could cover things like where to look for job logs and such also?
This may be a latter thing to think about. But I think that viewing outputs is really important first concept.
|
@bloodearnest Thanks - I'm going to merge this as is now, but will look at the new section this week, I think that's a good idea |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.