[DOCS-8348] Compass docs need updating Created: 14/Jul/16  Updated: 30/Oct/23  Resolved: 22/Aug/16

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

Type: Improvement Priority: Major - P3
Reporter: Sam Weaver Assignee: Steve Renaker (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
Duplicate
Related
Participants:
Days since reply: 7 years, 28 weeks, 1 day ago
Story Points: 4

 Description   

I have updated the documentation internally, we should reflect on docs site.

https://docs.google.com/document/d/1XUn8Hd7PwqznWk7q1U6d_6ibD2PbDYzCYGRDmEe8MuE/edit#



 Comments   
Comment by Steve Renaker (Inactive) [ 02/Aug/16 ]

matt.kangas Regarding the FAQ, would you prefer to use the existing FAQ as it is (https://docs.mongodb.com/compass/faq/) for the 1.3 Beta docs? It looks like there's nothing there that isn't applicable for the new version.

Comment by Matt Kangas [ 01/Aug/16 ]

Let's confirm that we address these concerns.

Attendees at World often asked:

"Where is there documentation?"
"Is there documentation about this (or lack of) feature?"
"How should I be using Compass?"
"Is there a demo, tutorial, or video on how to use Compass?"

Comment by Lucas Hrabovsky (Inactive) [ 29/Jul/16 ]
{mongodb.fanclub}

dataset:

Comment by Steve Renaker (Inactive) [ 29/Jul/16 ]

OK thanks, I'll make it so.

Comment by Matt Kangas [ 29/Jul/16 ]

steve.renaker the address for feedback should be compass@mongodb.com - unless sam.weaver disagrees.

Comment by Steve Renaker (Inactive) [ 29/Jul/16 ]

sam.weaver, it looks like the mailto: address for feedback in the disclaimer is given as 3.2beta@mongodb.com. Is that correct?

Comment by Steve Renaker (Inactive) [ 29/Jul/16 ]

matt.kangas Thanks for the heads-up. I'll add a compatibility matrix to the Overview section.

Comment by Sam Weaver [ 29/Jul/16 ]

FYI, the server is back up today if you want to grab the screenshots on the
dataset the IP is here:

10.4.126.113

{ name : "Sam Weaver",
title : "Product Manager",
phone : "+447549938422",
location : ["New York City, NY", "London, UK"],
twitter : ["@Samuel_Weaver <https://www.twitter.com/samuel_weaver>", "
@MongoDB <https://www.twitter.com/mongodb>"],
facebook : "MongoDB <https://www.facebook.com/mongodb>" }

Comment by Matt Kangas [ 29/Jul/16 ]

steve.renaker while you're working at this, note a recent request: INT-1694 "Provide documentation on MongoDB versions compatible with Compass"

MongoDB Compass is compatible with MongoDB 2.6 and up (both Enterprise and Community editions).

Shall we add this to the FAQ? To Getting Started?

Comment by Sam Weaver [ 28/Jul/16 ]

I turned it off for the night, it'll be back up tomorrow!

{ name : "Sam Weaver",
title : "Product Manager",
phone : "+447549938422",
location : ["New York City, NY", "London, UK"],
twitter : ["@Samuel_Weaver <https://www.twitter.com/samuel_weaver>", "
@MongoDB <https://www.twitter.com/mongodb>"],
facebook : "MongoDB <https://www.facebook.com/mongodb>" }

Comment by Steve Renaker (Inactive) [ 28/Jul/16 ]

Got it, thanks!

Comment by Sam Weaver [ 28/Jul/16 ]

If you're not in the office, you need to be on the VPN...

{ name : "Sam Weaver",
title : "Product Manager",
phone : "+447549938422",
location : ["New York City, NY", "London, UK"],
twitter : ["@Samuel_Weaver <https://www.twitter.com/samuel_weaver>", "
@MongoDB <https://www.twitter.com/mongodb>"],
facebook : "MongoDB <https://www.facebook.com/mongodb>" }

Comment by Sam Weaver [ 28/Jul/16 ]

You should be able to connect to my machine running the dataset on this IP:

10.4.126.113

Im using the mongodb/fancluub db/collection.

{ name : "Sam Weaver",
title : "Product Manager",
phone : "+447549938422",
location : ["New York City, NY", "London, UK"],
twitter : ["@Samuel_Weaver <https://www.twitter.com/samuel_weaver>", "
@MongoDB <https://www.twitter.com/mongodb>"],
facebook : "MongoDB <https://www.facebook.com/mongodb>" }

Comment by Steve Renaker (Inactive) [ 28/Jul/16 ]

sam.weaver That's fine, I'll go ahead and make the images. Can you send me the dataset? Thanks.

Comment by Sam Weaver [ 28/Jul/16 ]

Do you need a copy of al images from that document? When do you need them
by? I won't be able to get to this for a little while. It might be easier
for me to send you the dataset I used and you can recreate the images
locally.

{ name : "Sam Weaver",
title : "Product Manager",
phone : "+447549938422",
location : ["New York City, NY", "London, UK"],
twitter : ["@Samuel_Weaver <https://www.twitter.com/samuel_weaver>", "
@MongoDB <https://www.twitter.com/mongodb>"],
facebook : "MongoDB <https://www.facebook.com/mongodb>" }

Comment by Matt Kangas [ 28/Jul/16 ]

Steve, sam.weaver is the author of the beta documentation. Ping him to see if he has high-resolution versions to add to our shared folder. Otherwise we will have to recreate

Comment by Steve Renaker (Inactive) [ 28/Jul/16 ]

lucas.hrabovsky I'm happy to make the images, but they'll reflect my local mongod instance, which has different data in it from the instance the docs authors used...that might look a bit odd.

Comment by Lucas Hrabovsky (Inactive) [ 28/Jul/16 ]

steve.renaker was going to redo screenshots later this afternoon bu if you wouldn't mind recreating at higher res that would be amazing

Comment by Steve Renaker (Inactive) [ 28/Jul/16 ]

The documentation images are pretty specific to the documentation verbiage, so I think it's better if I choose the images to go in the docs-compass repo. Thanks for sending the link.

Comment by Lucas Hrabovsky (Inactive) [ 28/Jul/16 ]

It's not quite finished yet but we will put all of the images in this Google Drive folder. Would it be easier if I just sent you a pull request on the docs-compass repo?

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