(DOCSP-19330) Update source constants in Node v3.6 branch #273
Conversation
snooty.toml
Outdated
| mongosh = "``mongosh``" | ||
| driver = "node" |
There was a problem hiding this comment.
Comment: As these source constants are not used, should these be removed? This is sort of related to this PR discussion around constants (may fall under YAGNI).
There was a problem hiding this comment.
Sounds good - removing them. Thanks for the context 👍
source/index.txt
Outdated
| Node.js driver, see the `MongoDB Node.js driver API documentation | ||
| <{+api+}>`__ . |
There was a problem hiding this comment.
Question: The :node-api-3.6: constant seems to still be used a good bit throughout the docs. It seems like it could cause confusion to have some links use :node-api-3.6: and some links use the constant, but I could be incorrect. Should all :node-api-3.6: links be updated? If not, would it make sense to make another ticket to perform this replacement?
I read the A/C for the ticket and it seemed sparse (did not include TOC update), so not sure if this should or should not be a part of this ticket.
There was a problem hiding this comment.
Good catch, there are many more uses of :node-api-3.6: and I do think we should keep it consistent.
I tested a handful of the :node-api-3.6: links and they all work, which raises the YAGNI-esque question for me - why replace these with a new api constant?
I reverted the change on the index page back to using :node-api-3.6: - this seems like the simplest solution. I'll bring it up in standup and please let me know what you think.
|
Created a ticket to swap instances of the Snooty directive :node-api-3.6: with the newer api source constant: |
* (DOCSP-19330) Update source constants in Node v3.6 branch
Pull Request Info
Issue JIRA link:
https://jira.mongodb.org/browse/DOCSP-19330
Snooty build log:
https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=61d75d7f41accb36337011e7
Snooty build logs aren't working at the moment
Docs staging link (requires sign-in on MongoDB Corp SSO):
https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-19330/
Self-Review Checklist
If your page documents a concept, does it meet the following criteria?