[DOCS-10935] The connect() function is not linked to on mongo CLI’s documentation page where expected Created: 23/Oct/17  Updated: 29/Oct/23  Resolved: 26/Oct/17

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Minor - P4
Reporter: Nathan Phillip Brink (binki) Assignee: Allison Reinheimer Moore
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File image-2017-10-23-10-32-30-638.png    
Participants:
Days since reply: 6 years, 15 weeks, 6 days ago
Story Points: 0.1

 Description   

If I visit https://docs.mongodb.com/manual/reference/method/#connection , I see . In that list, I would expect `connect()` to be a clickable link, but it isn’t. To navigate to `connect()`, I have to click on the `MongoDB()` link and then use the prev/next navigation to navigate to the previous documentation which finally gets me to the documentation for `connect()`.

The very fact that `connect()` is not a link on the `mongo` CLI documentation page makes me think that there isn’t any documentation on the command. So after giving up looking for the docs the first time, I had to experiment to figure out how its `url` parameter works (hint: it doesn’t actually accept a URL!). Then later I found I was able to indirectly get to `connect()`’ docs and then saw that URIs are not supported and learned how to pass username/password correctly.

I think this stumbling could be saved for others if the link was added.

Thanks.



 Comments   
Comment by Githook User [ 26/Oct/17 ]

Author:

{'email': 'allison.moore@10gen.com', 'name': 'Allison Moore', 'username': 'schmalliso'}

Message: DOCS-10935: hacky solution to make non-linking methods link
Branch: v3.4
https://github.com/mongodb/docs/commit/f76b79a44ce71e2531a1addc35e62b3d8961e4a2

Comment by Githook User [ 26/Oct/17 ]

Author:

{'email': 'allison.moore@10gen.com', 'name': 'Allison Moore', 'username': 'schmalliso'}

Message: DOCS-10935: hacky solution to make non-linking methods link
Branch: master
https://github.com/mongodb/docs/commit/c1b09c7130882fd4d9653eeb46c9ca70ddc20780

Generated at Thu Feb 08 08:01:42 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.