Skip to content

DOCSP-48859 Add RESTful API tutorial #617

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

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

stephmarie17
Copy link
Collaborator

@stephmarie17 stephmarie17 commented Apr 18, 2025

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-48859

Staging Links

  • fundamentals/crud/restful-api-tutorial
  • fundamentals/crud
  • Self-Review Checklist

    • Is this free of any warnings or errors in the RST?
    • Did you run a spell-check?
    • Did you run a grammar-check?
    • Are all the links working?
    • Are the facets and meta keywords accurate?
    • Are the page titles greater than 20 characters long and SEO relevant?

    Copy link

    netlify bot commented Apr 18, 2025

    Deploy Preview for docs-csharp ready!

    Name Link
    🔨 Latest commit 65c065c
    🔍 Latest deploy log https://app.netlify.com/sites/docs-csharp/deploys/680bc3bb101e2c0008434387
    😎 Deploy Preview https://deploy-preview-617--docs-csharp.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @stephmarie17 stephmarie17 marked this pull request as ready for review April 22, 2025 23:33
    @rustagir rustagir self-requested a review April 23, 2025 16:34
    @@ -12,6 +12,8 @@ CRUD Operations

    Write </fundamentals/crud/write-operations>
    Read </fundamentals/crud/read-operations>
    Tutorial: Create a RESTful API </fundamentals/crud/restful-api-tutorial>
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: consider creating a tutorials drawer so that there's scaffolding for adding more tutorials in the future. I'm also not sure this belongs in the CRUD drawer, maybe it could be a top level Tutorials drawer? This page seems to touch on more than just simple crud operations.

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    I see what you mean! When discussing incorporating these docs+ articles, the shift has been away from L1 drawers that are broad and format-based and instead incorporating the content into the use case instead. This CRUD section will be updated and moved up to an L1 when CC is done so it made sense for now to put this here and include the "Tutorial" callout in the title to differentiate from the guides.

    Comment on lines +3 to +5
    =====================================================================
    Tutorial: Create a RESTful API with the {+driver-short+} Driver
    =====================================================================
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    S: Remove tutorial from the title if this will be in a tutorials drawer

    @@ -0,0 +1,384 @@
    .. _csharp-crud-restful-api-tutorial:
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    .. _csharp-crud-restful-api-tutorial:
    .. _csharp-tutorial-restful-api:

    @stephmarie17 stephmarie17 requested a review from rustagir April 25, 2025 20:15
    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.

    2 participants