-
Notifications
You must be signed in to change notification settings - Fork 16
Update the schema documentation to improve the usability. #1286
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
Conversation
Reviewer's Guide by SourceryThis 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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
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. |
There was a problem hiding this comment.
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.
| 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). |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
PR Description
Adds documentation on how to create schemas.
Tasks
Summary by Sourcery
Documentation: