[DOCS-11200] Improve install_compass experience on OSX (SERVER-32211) Created: 12/Jan/18  Updated: 29/Oct/23  Resolved: 23/Jan/18

Status: Closed
Project: Documentation
Component/s: Compass
Affects Version/s: None
Fix Version/s: 3.7.1, 3.6.1

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Jeffrey Allen
Resolution: Fixed Votes: 0
Labels: install
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

https://docs.mongodb.com/manual/reference/program/install_compass/index.html


Issue Links:
Documented
documents SERVER-32211 install_compass experience on OSX nee... Closed
Participants:
Days since reply: 6 years, 3 weeks, 1 day ago
Epic Link: DOCS: 4.0 Server
Story Points: 0.3

 Description   

Documentation Request Summary:

Python is no longer required for install_compass on Mac:
https://docs.mongodb.com/manual/reference/program/install_compass/index.html

Should probably add a note that it will always update compass removing any old versions found.

Engineering Ticket Description:

The download/install experience for compass is broken.

I tried downloading the tarball for OSX. The directory contains a bare python script (with no standard .py extension. There is no README to tell me what to do with the install_compass file.

If I try to click on the file in the finder, most user will get the "install_compass can't be opened because it is from an unidentified developer." I can work around by changing my security settings for this one file. But then....

If I try to open it either from the finder or command line, I get this error from a launched term window:

Last login: Thu Dec  7 14:53:41 on ttys010
Reusing existing ssh-agent
Agent pid 1874
 
[crucible]~ 02:56 PM 
$ /Users/monkey101/dist/3.6.0/bin/install_compass ; exit;
env: python2: No such file or directory
logout
Saving session...
...copying shared history...
...saving history...truncating history files...
...completed.
 
[Process completed]

If I try to run it from the command line: ./install_compass, I get this:

monkey101:bin$ ./install_compass
env: python2: No such file or directory

If I run it by explicitly using python I get a lot of output which is not going to mean much to the average user:

monkey101:bin$ python install_compass
Downloading Compass... 100%
Installing the package...
Checksumming Protective Master Boot Record (MBR : 0)…
Protective Master Boot Record (MBR :: verified   CRC32 $03CAA81A
Checksumming GPT Header (Primary GPT Header : 1)…
 GPT Header (Primary GPT Header : 1): verified   CRC32 $BBAB1D51
Checksumming GPT Partition Data (Primary GPT Table : 2)…
GPT Partition Data (Primary GPT Tabl: verified   CRC32 $02567F93
Checksumming  (Apple_Free : 3)…
                    (Apple_Free : 3): verified   CRC32 $00000000
Checksumming disk image (Apple_HFS : 4)…
.........................................................................................................................................................................................................................................................................................................................................................................
          disk image (Apple_HFS : 4): verified   CRC32 $17E7665D
Checksumming  (Apple_Free : 5)…
                    (Apple_Free : 5): verified   CRC32 $00000000
Checksumming GPT Partition Data (Backup GPT Table : 6)…
GPT Partition Data (Backup GPT Table: verified   CRC32 $02567F93
Checksumming GPT Header (Backup GPT Header : 7)…
  GPT Header (Backup GPT Header : 7): verified   CRC32 $63E2C8D8
verified   CRC32 $A751359B
/dev/disk3          	GUID_partition_scheme
/dev/disk3s1        	Apple_HFS                      	/private/var/folders/4r/5v2776px5bjczh16mwyt7zx80000gq/T/tmpV2Ox1G
Old version found removing...
Copying MongoDB Compass Community.app to /Applications
"disk3" unmounted.
"disk3" ejected.
Cleaning up...
Done!

I thought we were delivering a .dmg?



 Comments   
Comment by Githook User [ 23/Jan/18 ]

Author:

{'name': 'jeff-allen-mongo', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}

Message: DOCS-11200 - Updating install_compass install docs for Linux and Mac
Branch: master
https://github.com/mongodb/docs/commit/aa9a631851901bf7e5b515ea6400ee1ecf8243c2

Comment by Jeffrey Allen [ 23/Jan/18 ]

This is RFM:

https://github.com/mongodb/docs/pull/3203

Comment by Jeffrey Allen [ 22/Jan/18 ]

Code review: https://mongodbcr.appspot.com/175980001/

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