Skip to content

Commit 95a116e

Browse files
authored
COMPASS-3823: Update links to open sourced plugins
1 parent 4bc43a3 commit 95a116e

File tree

1 file changed

+7
-110
lines changed

1 file changed

+7
-110
lines changed

README.md

Lines changed: 7 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -1,119 +1,16 @@
1-
# compass [![][travis_img]][travis_url]
1+
# MongoDB Compass [![][travis_img]][travis_url]
22

3-
Explore your MongoDB.
3+
## Plugins
44

5-
## Development
6-
7-
1. Follow the setup instructions for [macOS][setup-mac-os], [Windows][setup-windows] or [Linux][setup-linux].
8-
1. [Set up SSH](https://help.github.com/articles/which-remote-url-should-i-use/#cloning-with-ssh-urls)
9-
1. Then copy/paste:
10-
11-
```bash
12-
# Get the source code by cloning the compass repository
13-
git clone [email protected]:10gen/compass.git
14-
15-
# Change directory into the newly cloned repo
16-
cd compass
17-
18-
# Install dependencies
19-
# Note: If you haven't already, you may need to run
20-
# npm login
21-
# with an npm account which has been granted membership to
22-
# https://www.npmjs.com/org/mongodb-js
23-
# in order to download and install private npm modules like
24-
# https://www.npmjs.com/package/@mongodb-js/compass-schema-validation
25-
npm install
26-
27-
# Build and launch the app, passing a distribution as an argument.
28-
npm start compass
29-
npm start compass-community
30-
npm start compass-readonly
31-
npm start compass-isolated
32-
```
33-
34-
### Master is broken
35-
36-
Try:
37-
38-
```
39-
rm -rf node_modules && npm cache verify && npm install && npm start
40-
```
41-
42-
## Key Modules
43-
44-
Note this is a polylithic (as opposed to a monolithic) repository - it aims to make Compass
45-
a minimal shell and abstract as much as possible into reusable, highly decoupled components.
46-
Please see the mongodb-js org for all the repos: https://github.com/mongodb-js
47-
48-
## Building Releases
49-
50-
💡 Most of the time you don't need these, as [Evergreen][evergreen-compass-docs] builds them for us.
51-
52-
After you've made some local changes, the next thing you'll probably want to do
53-
is create an artifact to share. There is only one command you need to run to compile the app,
54-
sign it if the signing certificate is available on your machine, and generate a single file
55-
installer for your current platform:
56-
57-
```bash
58-
npm run release compass
59-
npm run release compass-community
60-
npm run release compass-readonly
61-
npm run release compass-isolated
62-
```
63-
64-
## The Release Process
65-
66-
Please see our [Compass Internal Docs on our release-process](https://github.com/10gen/compass-internal-docs/tree/master/release-process) for more information.
67-
68-
## Running Tests
69-
70-
```bash
71-
# Run the entire test suite
72-
npm test
73-
```
74-
75-
For more details, see our [test README](test/README.md).
76-
77-
## External Plugins
78-
79-
Here is the current list of external plugins Compass uses and their locations.
5+
> [See the compass-plugin GitHub topic](https://github.com/search?q=topic%3Acompass-plugin+org%3Amongodb-js&type=Repositories)
806
817
- [@mongodb-js/compass-aggregations](https://github.com/mongodb-js/compass-aggregations)
82-
- [@mongodb-js/compass-auth-kerberos](https://github.com/10gen/compass-auth-kerberos)
83-
- [@mongodb-js/compass-auth-ldap](https://github.com/10gen/compass-auth-ldap)
84-
- [@mongodb-js/compass-auth-x509](https://github.com/10gen/compass-auth-x509)
85-
- [@mongodb-js/compass-collection-stats](https://github.com/mongodb-js/compass-collection-stats)
86-
- [@mongodb-js/compass-connect](https://github.com/10gen/compass-connect)
87-
- [@mongodb-js/compass-crud](https://github.com/10gen/compass-crud)
88-
- [@mongodb-js/compass-deployment-awareness](https://github.com/mongodb-js/compass-deployment-awareness)
89-
- [@mongodb-js/compass-schema-validation](https://github.com/10gen/compass-schema-validation)
8+
- [@mongodb-js/compass-connect](https://github.com/mongodb-js/compass-connect)
9+
- [@mongodb-js/compass-crud](https://github.com/mongodb-js/compass-crud)
9010
- [@mongodb-js/compass-export-to-language](https://github.com/mongodb-js/compass-export-to-language)
9111
- [@mongodb-js/compass-import-export](https://github.com/mongodb-js/compass-import-export)
92-
- [@mongodb-js/compass-instance](https://github.com/mongodb-js/compass-instance)
93-
- [@mongodb-js/compass-license](https://github.com/10gen/compass-license)
94-
- [@mongodb-js/compass-plugin-info](https://github.com/mongodb-js/compass-plugin-info)
9512
- [@mongodb-js/compass-query-bar](https://github.com/mongodb-js/compass-query-bar)
9613
- [@mongodb-js/compass-query-history](https://github.com/mongodb-js/compass-query-history)
97-
- [@mongodb-js/compass-server-version](https://github.com/mongodb-js/compass-server-version)
98-
- [@mongodb-js/compass-serverstats](https://github.com/10gen/compass-serverstats)
99-
- [@mongodb-js/compass-ssh-tunnel-status](https://github.com/mongodb-js/compass-ssh-tunnel-status)
100-
- [@mongodb-js/compass-status](https://github.com/mongodb-js/compass-status)
101-
102-
## Code Quality Tools
103-
104-
The following are employed by the Compass team:
105-
106-
* Evergreen, how we build Compass:
107-
- Your JIRA login should grant access to https://evergreen.mongodb.com/waterfall/10gen-compass-master
108-
- You can also [use the command line tool](https://github.com/evergreen-ci/evergreen/wiki/Using-the-command-line-tool)
109-
* [TravisCI](https://travis-ci.com/10gen/compass) - runs continuous integration tests, PRs should only be merged if they keep it green
110-
* [Greenkeeper](https://greenkeeper.io/) - Creates pull requests to update submodules (i.e. @ [greenkeeperio-bot](https://github.com/greenkeeperio-bot) creates PRs to remind you and the Compass team to propagate submodule updates upwards through the Compass dependency tree)
111-
* [Bugsnag](https://app.bugsnag.com/mongodb/mongodb-compass/) - Reminds us to fix errors customers are experiencing
112-
* [Intercom](https://app.intercom.io/a/apps/p57suhg7/) - Allows us to get feedback directly from customers and work with them via chat messages
11314

114-
[setup-mac-os]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#mac-os-setup
115-
[setup-windows]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#windows-setup
116-
[setup-linux]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#linux-setup
117-
[travis_img]: https://magnum.travis-ci.com/10gen/compass.svg?token=q2zsnxCbboarF6KYRYxM&branch=master
118-
[travis_url]: https://magnum.travis-ci.com/10gen/compass
119-
[evergreen-compass-docs]: https://github.com/10gen/compass-internal-docs/blob/master/evergreen.md
15+
[travis_img]: https://travis-ci.org/mongodb-js/compass.svg
16+
[travis_url]: https://travis-ci.org/mongodb-js/compass

0 commit comments

Comments
 (0)