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

[ENH] Updated How to get data modal #370

Merged
merged 5 commits into from
Nov 25, 2024
Merged

[ENH] Updated How to get data modal #370

merged 5 commits into from
Nov 25, 2024

Conversation

rmanaem
Copy link
Contributor

@rmanaem rmanaem commented Nov 24, 2024

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass
  • If the PR changes the participant-level and/or the dataset-level result file, the query-tool-results files in the neurobagel_examples repo have been regenerated

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

Copy link

sourcery-ai bot commented Nov 24, 2024

Reviewer's Guide by Sourcery

This PR updates the "How to get data" modal with improved UI/UX and clearer instructions. The implementation reorganizes the content layout, adds a copy button functionality for the Docker command, and enhances the explanatory text. The changes use Material-UI components and React hooks for state management.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Reorganized modal content structure and enhanced typography
  • Added section headers with bold typography
  • Restructured content flow with clearer explanations
  • Updated text content to be more descriptive and user-friendly
  • Consolidated MUI imports into a single statement
src/components/GetDataDialog.tsx
Added copy functionality for Docker command
  • Implemented a copy button with IconButton and ContentCopyIcon
  • Added a temporary success Popover notification
  • Created state management for copy functionality using React hooks
  • Stored Docker command as a constant variable
src/components/GetDataDialog.tsx
Improved visual styling and layout
  • Added a gray background container for the Docker command
  • Implemented flexible layout using flex classes
  • Added proper spacing and margins around components
  • Applied consistent styling using theme colors
src/components/GetDataDialog.tsx

Assessment against linked issues

Issue Objective Addressed Explanation
#367 Update the instructions for how to get data

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@rmanaem rmanaem requested a review from alyssadai November 24, 2024 22:44
Copy link

netlify bot commented Nov 24, 2024

Deploy Preview for neurobagel-query ready!

Name Link
🔨 Latest commit c67d0bd
🔍 Latest deploy log https://app.netlify.com/sites/neurobagel-query/deploys/6744c94a69679d00081c5842
😎 Deploy Preview https://deploy-preview-370--neurobagel-query.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rmanaem rmanaem added release Create a release when this PR is merged pr-minor Non-breaking feature or enhancement, will increment minor version (0.+1.0) labels Nov 24, 2024
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @rmanaem - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please fill out the 'Changes proposed' section in the PR description to help reviewers understand the changes at a high level.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

src/components/GetDataDialog.tsx Show resolved Hide resolved
src/components/GetDataDialog.tsx Show resolved Hide resolved
Copy link
Contributor

@alyssadai alyssadai left a comment

Choose a reason for hiding this comment

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

Thanks @rmanaem for the lovely UI changes and updated modal text. The copy button for the code snippet works great!

Looking at the preview again, I'm struck by how long the modal still is (following my suggested edits), so I've left some suggestions below to further trim and simplify the text.

Otherwise, 🧑‍🍳 !!

src/components/GetDataDialog.tsx Outdated Show resolved Hide resolved
src/components/GetDataDialog.tsx Outdated Show resolved Hide resolved
src/components/GetDataDialog.tsx Outdated Show resolved Hide resolved
src/components/GetDataDialog.tsx Outdated Show resolved Hide resolved
src/components/GetDataDialog.tsx Outdated Show resolved Hide resolved
@alyssadai
Copy link
Contributor

Hey @rmanaem, for the sake of re-releasing, I'm going to apply my suggested changes and merge!

@alyssadai alyssadai merged commit 7e9aeb9 into main Nov 25, 2024
9 checks passed
@alyssadai alyssadai deleted the enh-367 branch November 25, 2024 19:04
Copy link
Contributor

🚀 PR was released in v0.7.0 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-minor Non-breaking feature or enhancement, will increment minor version (0.+1.0) release Create a release when this PR is merged released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the how to get data modal
2 participants