feat: Detect firewall branch for 15.3.0 #671

aaronm-2112 · 2024-12-31T17:56:08Z

Summary by Sourcery

Documentation:

Document how to resolve network issues when using SODA.

fairdataihub-bot · 2024-12-31T17:56:11Z

Thank you for submitting this pull request! We appreciate your contribution to the project. Before we can merge it, we need to review the changes you've made to ensure they align with our code standards and meet the requirements of the project. We'll get back to you as soon as we can with feedback. Thanks again!

sourcery-ai · 2024-12-31T17:56:13Z

Reviewer's Guide by Sourcery

This pull request introduces a new how-to guide for resolving network issues. It provides background information on common network problems and suggests steps to resolve them, including gathering logs and contacting the appropriate support teams.

Sequence diagram for network issue resolution workflow

sequenceDiagram
    actor User
    participant SODA
    participant NetworkAdmin
    participant SODASupport

    User->>SODA: Navigate to Contact Us page
    User->>SODA: Click Gather Logs button
    SODA-->>User: Generate error logs
    User->>NetworkAdmin: Share logs
    alt Issue resolved
        NetworkAdmin-->>User: Provide solution
    else Issue not resolved
        User->>SODASupport: Send logs to help@fairdataihub.org
        SODASupport-->>User: Provide assistance
    end

File-Level Changes

Change	Details	Files
Added a new how-to guide for resolving network issues.	Created a new markdown file with instructions on how to resolve network issues. Included steps for gathering logs and contacting support. Added a TODO to include a note on where to look in the logs for relevant information.	`docs/how-to/how-to-resolve-network-issues.md`

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

vercel · 2024-12-31T17:56:13Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
soda-for-sparc-docs	❌ Failed (Inspect)			Dec 31, 2024 8:48pm

fairdataihub-bot · 2024-12-31T17:56:18Z

Thanks for making updates to your pull request. Our team will take a look and provide feedback as soon as possible. Please wait for any GitHub Actions to complete before editing your pull request. If you have any additional questions or concerns, feel free to let us know. Thank you for your contributions!

sourcery-ai

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

Overall Comments:

The PR contains incomplete sections: an empty bullet point in the list of affected users and a TODO comment about log locations. Please complete these sections before this can be merged.

Here's what I looked at during the review

🟡 General issues: 2 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 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.}

sourcery-ai · 2024-12-31T17:57:08Z

docs/how-to/how-to-resolve-network-issues.md

+sidebar_position: 9
+pagination_next: null
+title: How to resolve network issues
+image: https://kalai.fairdataihub.org/api/generate?app=soda-for-sparc&title=Reinstall%20the%20Pennsieve%20Agent&description=%27How%20to%27%20SPARC%20series&org=fairdataihub


issue (typo): Typo in image URL: "Reinstall Pennsieve Agent" should be "Resolve Network Issues"

The title in the image URL should match the document title for consistency.

Suggested change

image: https://kalai.fairdataihub.org/api/generate?app=soda-for-sparc&title=Reinstall%20the%20Pennsieve%20Agent&description=%27How%20to%27%20SPARC%20series&org=fairdataihub

image: https://kalai.fairdataihub.org/api/generate?app=soda-for-sparc&title=Resolve%20Network%20Issues&description=%27How%20to%27%20SPARC%20series&org=fairdataihub

sourcery-ai · 2024-12-31T17:57:08Z

docs/how-to/how-to-resolve-network-issues.md

+1. Navigate to the 'Contact Us' page in the sidebar.
+2. Click the 'Gather Logs' button and select a directory where you would like SODA to generate its error logs.
+3. Contact your network administrator and provide them with the logs.
+4. If the network administrator is unable to resolve the issue, please contact the SODA team for further assistance by sending the logs to help@fairdataihub.org`;


issue (typo): Stray backtick after email address

Suggested change

4. If the network administrator is unable to resolve the issue, please contact the SODA team for further assistance by sending the logs to help@fairdataihub.org`;

4. If the network administrator is unable to resolve the issue, please contact the SODA team for further assistance by sending the logs to help@fairdataihub.org.

sonarqubecloud · 2024-12-31T20:46:39Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

fairdataihub-bot · 2025-03-02T19:39:16Z

Stale pull request

fairdataihub-bot · 2025-03-09T19:39:21Z

Thanks for closing this pull request! If you have any further questions, please feel free to open a new issue. We are always happy to help!

aaronm-2112 added 2 commits November 6, 2024 16:34

wip: 🚧 firewall detection docs

84d95e5

wip: 🚧 firewall detection docs

ea552f8

aaronm-2112 requested a review from bvhpatel as a code owner December 31, 2024 17:56

sourcery-ai bot reviewed Dec 31, 2024

View reviewed changes

aaronm-2112 added 2 commits December 31, 2024 12:01

chore: 🔨 update changelog

216daec

feat: ✨ version docs for 15.3.0

9e3c9bd

vercel bot had a problem deploying to Preview December 31, 2024 20:07 Failure

fix: 🐛 img path

2b01f2d

vercel bot had a problem deploying to Preview December 31, 2024 20:12 Failure

chore: 🔨 trim sidebar

3a14904

vercel bot had a problem deploying to Preview December 31, 2024 20:30 Failure

fix: 🐛 remove missing versions from version json

c20a6fd

vercel bot had a problem deploying to Preview December 31, 2024 20:38 Failure

build: 📦️ reset react to be compatible with docusaur

1b3cba8

aaronm-2112 requested a review from megasanjay as a code owner December 31, 2024 20:46

vercel bot had a problem deploying to Preview December 31, 2024 20:48 Failure

fairdataihub-bot added the no-pr-activity label Mar 2, 2025

fairdataihub-bot closed this Mar 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Detect firewall branch for 15.3.0 #671

feat: Detect firewall branch for 15.3.0 #671

aaronm-2112 commented Dec 31, 2024 •

edited by sourcery-ai bot

Loading

fairdataihub-bot bot commented Dec 31, 2024

sourcery-ai bot commented Dec 31, 2024 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

vercel bot commented Dec 31, 2024 •

edited

Loading

fairdataihub-bot bot commented Dec 31, 2024

sourcery-ai bot left a comment

sourcery-ai bot Dec 31, 2024

sourcery-ai bot Dec 31, 2024

sonarqubecloud bot commented Dec 31, 2024

fairdataihub-bot commented Mar 2, 2025

fairdataihub-bot bot commented Mar 9, 2025

	image: https://kalai.fairdataihub.org/api/generate?app=soda-for-sparc&title=Reinstall%20the%20Pennsieve%20Agent&description=%27How%20to%27%20SPARC%20series&org=fairdataihub
	image: https://kalai.fairdataihub.org/api/generate?app=soda-for-sparc&title=Resolve%20Network%20Issues&description=%27How%20to%27%20SPARC%20series&org=fairdataihub

	4. If the network administrator is unable to resolve the issue, please contact the SODA team for further assistance by sending the logs to help@fairdataihub.org`;
	4. If the network administrator is unable to resolve the issue, please contact the SODA team for further assistance by sending the logs to help@fairdataihub.org.

feat: Detect firewall branch for 15.3.0 #671

feat: Detect firewall branch for 15.3.0 #671

Conversation

aaronm-2112 commented Dec 31, 2024 • edited by sourcery-ai bot Loading

Summary by Sourcery

fairdataihub-bot bot commented Dec 31, 2024

sourcery-ai bot commented Dec 31, 2024 • edited Loading

Reviewer's Guide by Sourcery

Sequence diagram for network issue resolution workflow

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

vercel bot commented Dec 31, 2024 • edited Loading

fairdataihub-bot bot commented Dec 31, 2024

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Dec 31, 2024

Choose a reason for hiding this comment

sourcery-ai bot Dec 31, 2024

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 31, 2024

Quality Gate passed

fairdataihub-bot commented Mar 2, 2025

fairdataihub-bot bot commented Mar 9, 2025

aaronm-2112 commented Dec 31, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Dec 31, 2024 •

edited

Loading

vercel bot commented Dec 31, 2024 •

edited

Loading