Skip to content

Conversation

@JoshuaSBrown
Copy link
Collaborator

@JoshuaSBrown JoshuaSBrown commented Feb 4, 2025

PR Description

Adds documentation on how to create schemas.

Tasks

  • - A description of the PR has been provided, and a diagram included if it is a new feature.
  • - Formatter has been run
  • - Labels have been assigned to the pr
  • - A reviwer has been added
  • - A user has been assigned to work on the pr

Summary by Sourcery

Documentation:

  • Document how to create schemas.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 4, 2025

Reviewer's Guide by Sourcery

This pull request adds documentation on how to create schemas, improving usability.

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

File-Level Changes

Change Details Files
Added documentation on how to create schemas.
  • Added a new section describing schema creation.
doc_source/source/user/web/portal.rst

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@JoshuaSBrown JoshuaSBrown added the Type: Docs - User User / admin documentation label Feb 4, 2025
@JoshuaSBrown JoshuaSBrown self-assigned this Feb 4, 2025
Copy link
Contributor

@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 @JoshuaSBrown - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please provide a more detailed PR description that explains what specific aspects of schema creation are being documented and what problems these changes help solve. This context is important for reviewers and future reference.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue 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.

Schemas
-------

DataFed currently supports schema creation for records through the web portal.
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Clarify schema management capabilities.

The introduction mentions schema creation. Clarify whether the portal also supports viewing and/or managing existing schemas. If not, explicitly state that the portal only supports schema creation.

Suggested change
DataFed currently supports schema creation for records through the web portal.
DataFed currently supports schema creation for records through the web portal. While schemas can be created through the portal interface, viewing and managing existing schemas must be done through other DataFed interfaces (such as the CLI or API).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, this needs to be done but the PR as it is already enriches the documentation. If we continue down this vein, then you end up with scope creep.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for your feedback, we will generate fewer comments like this in the future.

@JoshuaSBrown JoshuaSBrown linked an issue Feb 7, 2025 that may be closed by this pull request
@JoshuaSBrown JoshuaSBrown merged commit d204783 into devel Feb 10, 2025
14 checks passed
@JoshuaSBrown JoshuaSBrown deleted the 1280-docs-improve-user-docs-for-schema branch February 10, 2025 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Docs - User User / admin documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] - DataFed Schema docs

3 participants