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

[JN-477] admin help for export #481

Merged
merged 4 commits into from
Jul 20, 2023
Merged

[JN-477] admin help for export #481

merged 4 commits into from
Jul 20, 2023

Conversation

devonbush
Copy link
Collaborator

This adds basic help docs (copied over from Pepper) for the download capability. The existence of help docs within our app is probably temporary. Long-term, we'll want to use ZenDesk or some other solution that lets non-engineers write/edit the docs. I'll put in a request to comms to see about getting that set up. In the meantime, this will give us a place to park user-visible documentation. Also, having it be in-app makes the release/review process much simpler -- the docs get auto-released with the features, rather than having to be reviewed and released separately.

image image

TO TEST:

  1. Go to https://localhost:3000/ourhealth/env/live/participants
  2. click "download"
  3. click the link to the help page
  4. confirm the help page shows up in a new tab

Comment on lines +21 to +22
number of columns to be exported exceeds 16K. In order to have data be compliant, double-quotes will
be replaced by single quotes, and any values including
Copy link
Contributor

Choose a reason for hiding this comment

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

It isn't really necessary to replace double quotes with single quotes. It's unlikely that the meaning of any responses will be different, but I have to confess to being a little uneasy about any modification of responses.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

you're right that they can be escaped, but other applications handling of escaped quotes in csv files varies enough that it was decided for Pepper that this strategy would result in less user issues (and they can always grab the .xlsx format if quote fidelity is important)

<ExportDataControl studyEnvContext={mockStudyEnvContext()} show={true} setShow={() => {}}/>)
render(RoutedComponent)
userEvent.click(screen.getByText('help page'))
waitFor(() => expect(screen.getByText('Participant List Export Info')).toBeInTheDocument())
Copy link
Contributor

Choose a reason for hiding this comment

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

Interesting. I didn't expect to not need any code to recognize the content opened in a new window.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm guessing that the headless browser just ignores the target="_blank" and opens it in the same window

@devonbush devonbush added this pull request to the merge queue Jul 20, 2023
Merged via the queue into development with commit 82d7b7e Jul 20, 2023
6 checks passed
@devonbush devonbush deleted the db-admin-help branch July 20, 2023 17:51
TomConner pushed a commit that referenced this pull request Jul 28, 2023
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.

3 participants