Skip to content

DOCSP-47019 Shift Go ToC #499

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 4 commits into
base: comp-cov
Choose a base branch
from

Conversation

lindseymoore
Copy link
Collaborator

@lindseymoore lindseymoore commented May 10, 2025

Pull Request Info

PR Reviewing Guidelines

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

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 May 10, 2025

Deploy Preview for docs-golang ready!

Name Link
🔨 Latest commit 47c0e1c
🔍 Latest deploy log https://app.netlify.com/sites/docs-golang/deploys/6823caca4198aa0008ca1682
😎 Deploy Preview https://deploy-preview-499--docs-golang.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.

Copy link
Collaborator

@stephmarie17 stephmarie17 left a comment

Choose a reason for hiding this comment

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

ToC is looking good so far! Left some comments for a few suggestions and fixes.

@@ -10,25 +10,29 @@
:description: Learn how to use the MongoDB Go Driver.
:keywords: landing page, index

.. TODO cleanup
Copy link
Collaborator

Choose a reason for hiding this comment

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

[s] Maybe we can make a landing page ticket? Since the sections will need updates (e.g. remove "Fundamentals", rename some of the titles etc.)

==================
Connection Options
==================
==========================
Copy link
Collaborator

Choose a reason for hiding this comment

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

[i] I think this file needs to be moved up one level so that this drawer shows up in the ToC

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Created a Connection Options landing page!

===========
Connections
===========
==================
Copy link
Collaborator

Choose a reason for hiding this comment

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

[q] Is this duplicative of the connect page? Or meant to be something else?

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, will delete and update the connect page.

Query Operations
================

.. TODO Landing page
Copy link
Collaborator

Choose a reason for hiding this comment

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

[q] Can we add the toctree for the Query drawer in this PR so it's visible in the ToC or are you thinking of a separate ticket that would include that work?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added the drawer! Don't think an accessible landing page is necessary

@@ -0,0 +1,34 @@
.. _golang-crud:

===============
Copy link
Collaborator

Choose a reason for hiding this comment

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

[q] I wasn't able to access this page when clicking on the CRUD Operations title in the ToC, is that expected behavior?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added landing to the snooty file. Will check with Sarah if we should continue to do landing pages without significat content. We can always remove them during clean up if necessary.

@@ -0,0 +1,7 @@

Copy link
Collaborator

Choose a reason for hiding this comment

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

[s] Made a few comments about adding the refs at the top, but I wasn't sure if this was intentional and planned to be added later 😅

Copy link
Collaborator Author

@lindseymoore lindseymoore May 13, 2025

Choose a reason for hiding this comment

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

I did leave them off intentionally for the writer of the page to make/check which should be on the page based on what archive pages they use, but I am adding on the pages that you flagged in this review.

@@ -0,0 +1,5 @@
.. _go-connection-targets:
Copy link
Collaborator

Choose a reason for hiding this comment

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

[q] What do you think, should we stick with golang for all of these instead of go? I'm not sure what the more highly used one is but maybe as we're adding new files we can keep the same naming system.

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 we should stick with golang for consistency!

@lindseymoore lindseymoore requested a review from stephmarie17 May 13, 2025 22:47
Copy link
Collaborator

@stephmarie17 stephmarie17 left a comment

Choose a reason for hiding this comment

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

Those changes LGTM!

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