-
Notifications
You must be signed in to change notification settings - Fork 33
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
base: comp-cov
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for docs-golang ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
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 |
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.
[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 | ||
================== | ||
========================== |
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.
[i] I think this file needs to be moved up one level so that this drawer shows up in the ToC
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.
Created a Connection Options landing page!
source/connections.txt
Outdated
=========== | ||
Connections | ||
=========== | ||
================== |
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.
[q] Is this duplicative of the connect
page? Or meant to be something else?
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, will delete and update the connect
page.
source/crud/query.txt
Outdated
Query Operations | ||
================ | ||
|
||
.. TODO Landing page |
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.
[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?
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.
Added the drawer! Don't think an accessible landing page is necessary
@@ -0,0 +1,34 @@ | |||
.. _golang-crud: | |||
|
|||
=============== |
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.
[q] I wasn't able to access this page when clicking on the CRUD Operations
title in the ToC, is that expected behavior?
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.
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 @@ | |||
|
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.
[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 😅
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.
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: |
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.
[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.
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 we should stick with golang for consistency!
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.
Those changes LGTM!
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-47019
Self-Review Checklist