Skip to content

Conversation

@MongoCaleb
Copy link
Owner

@MongoCaleb MongoCaleb commented Aug 5, 2024

Pull Request Info - SDK Docs Consolidation

Jira ticket: https://jira.mongodb.org/browse/DOCSP-NNNNN

Staging Links

  • testfile2
  • testfile3
  • testfile4
  • testfile5
  • testfile6
  • testfile7
  • testfile8
  • testfile9
  • Page Source

    Add links to every SDK's pages where you got the SDK-specific information:

    PR Author Checklist

    Before requesting a review for your PR, please check these items:

    • Open the PR against the feature-consolidated-sdk-docs branch instead of master
    • Tag the consolidated page for:
      • genre
      • meta.keywords
      • meta.description

    Naming

    Links and Refs

    • Create new consolidated SDK ref targets starting with "_sdks-" for relevant sections
    • Remove or update any SDK-specific refs to use the new consolidated SDK ref targets
    • Update any Kotlin API links to use the new Kotlin SDK roles

    Content

    • Shared code boxes have snippets or placeholders for all 9 languages
    • API description sections have API details or a generic placeholder for all 9 languages
    • Check related pages for relevant content to include
    • Create a ticket for missing examples in each relevant SDK: Consolidation Gaps epic

    Reviewer Checklist

    As a reviewer, please check these items:

    • Shared code example boxes contain language-specific snippets or placeholders for every language
    • API reference details contain working API reference links or generic content
    • Realm naming/language has been updated
    • All relevant content from individual SDK pages is present on the consolidated page

    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.

    3 participants