feat!: 15.2.2 - Githubissues

aaronm-2112 commented 1 month ago

Summary by Sourcery

Update the SODA for SPARC documentation to version 15.2.2, introducing new features, fixing bugs, and enhancing user guidance. The update includes comprehensive documentation for advanced features, legal policies, and step-by-step guides for dataset curation and submission.

New Features:

Introduce a new version 15.2.2 of the documentation for SODA for SPARC, including detailed guides on project setup, building the application, and managing Pennsieve accounts.
Add comprehensive documentation for advanced features such as creating manifest files, comparing local and Pennsieve datasets, and validating datasets.
Include new legal documents such as Privacy Policy, Terms of Use, and Cookie Policy for version 15.2.2.

Bug Fixes:

Fix an issue with the Pennsieve agent version check that failed to detect outdated versions.
Resolve a bug in reading the config.ini file that incorrectly prioritized the 'SODA-Pennsieve' account name over the 'default_profile' key.
Correct issues in manifest creation and banner image upload/edit features that misdirected users without Pennsieve Agents.

Enhancements:

Improve the documentation structure by adding new sections for common errors and their solutions, and detailed 'How to' guides for various features.
Enhance the user experience by providing step-by-step guides for dataset curation and submission using SODA for SPARC.

Documentation:

Add extensive user-facing documentation for version 15.2.2, covering new features, bug fixes, and enhancements.
Include detailed guides on how to reinstall the Pennsieve Agent, test SODA without a Pennsieve account, and use workspaces effectively.

fairdataihub-bot[bot] commented 1 month ago

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!

vercel[bot] commented 1 month ago

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

Name	Status	Preview	Comments	Updated (UTC)
soda-for-sparc-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 9, 2024 5:21pm

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request implements version 15.2.2 of SODA for SPARC. The main changes include bug fixes related to the Pennsieve agent version check, config file reading, manifest creation, and upload error handling. The documentation has been updated to reflect these changes and new features.

User Journey Diagram for Pennsieve Agent Version Check Fix

journey
    title User Journey for Pennsieve Agent Version Check Fix
    section Before Fix
      User: User attempts to check Pennsieve agent version
      System: System fails to detect old versions
    section After Fix
      User: User attempts to check Pennsieve agent version
      System: System successfully detects old versions

User Journey Diagram for Config File Reading Fix

journey
    title User Journey for Config File Reading Fix
    section Before Fix
      User: User tries to authenticate with Pennsieve
      System: System always uses 'SODA-Pennsieve' account
    section After Fix
      User: User tries to authenticate with Pennsieve
      System: System uses 'default_profile' if available

User Journey Diagram for Manifest Creation and Upload Error Handling

journey
    title User Journey for Manifest Creation and Upload Error Handling
    section Before Fix
      User: User without Pennsieve Agent tries to upload
      System: System shows 'agent not running' error
    section After Fix
      User: User without Pennsieve Agent tries to upload
      System: System directs user to download page

File-Level Changes

Change	Details	Files
Updated changelog with version 15.2.2 bug fixes	Fixed Pennsieve agent version check for detecting old versions Fixed config.ini file reading issue with default profile selection Fixed manifest creation and banner image upload/edit features in Advanced Features tab Fixed potential undefined variable error in early upload failures	`versioned_docs/version-15.2.1/developer-documentation/changelog.md` `versioned_docs/version-15.2.2/developer-documentation/changelog.md`
Added version 15.2.2 to versions list	Inserted '15.2.2' at the beginning of the versions array	`versions.json`
Updated documentation for version 15.2.2	Added new versioned documentation folder for 15.2.2 Updated various documentation files to reflect changes and new features in 15.2.2	`versioned_docs/version-15.2.2/*`

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](https://app.sourcery.ai) 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](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

fairdataihub-bot[bot] commented 1 month ago

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!