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

Added export-schema command to Docs #546

Merged

Conversation

Ckk3
Copy link
Contributor

@Ckk3 Ckk3 commented Jun 6, 2024

Added export-schema command to Docs

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage)

Additional Information

I've also added the new page in the Guide menu:

image

Summary by Sourcery

This pull request adds new documentation for the export_schema management command, explaining its purpose, usage, and providing an example. The new documentation page has been added to the Guide section in the navigation menu.

  • Documentation:
    • Added documentation for the export_schema management command, detailing its usage, arguments, and options.
    • Included an example of how to use the export_schema command to export a GraphQL schema.

Copy link
Contributor

sourcery-ai bot commented Jun 6, 2024

Reviewer's Guide by Sourcery

This pull request adds documentation for the export-schema command, which is used to export a GraphQL schema defined using the strawberry_django library. The documentation includes usage instructions, arguments, options, and an example command. Additionally, the new documentation page is added to the Guide menu in the mkdocs.yml configuration file.

File-Level Changes

Files Changes
mkdocs.yml
docs/guide/export-schema.md
Added documentation for the export-schema command and updated the Guide menu to include the new documentation page.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@Ckk3 Ckk3 changed the title Add export-schema documentation Added export-schema command to Docs Jun 6, 2024
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 @Ckk3 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 5 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: 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 to tell me if it was helpful.

docs/guide/export-schema.md Outdated Show resolved Hide resolved
docs/guide/export-schema.md Outdated Show resolved Hide resolved
docs/guide/export-schema.md Outdated Show resolved Hide resolved
docs/guide/export-schema.md Outdated Show resolved Hide resolved
docs/guide/export-schema.md Show resolved Hide resolved
Ckk3 and others added 2 commits June 6, 2024 18:03
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.63%. Comparing base (90e1878) to head (81a47cd).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #546   +/-   ##
=======================================
  Coverage   88.63%   88.63%           
=======================================
  Files          41       41           
  Lines        3433     3433           
=======================================
  Hits         3043     3043           
  Misses        390      390           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Ckk3
Copy link
Contributor Author

Ckk3 commented Jun 6, 2024

Please let me know if this PR need some changes!

@bellini666
Copy link
Member

Awesome! Thanks for this :)

@bellini666 bellini666 merged commit 9454e99 into strawberry-graphql:main Jun 7, 2024
50 checks passed
@Ckk3 Ckk3 deleted the add-export-schema-documentation branch June 7, 2024 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants