From 1128f42cd5efc69dac1183f48349978d2580f93b Mon Sep 17 00:00:00 2001 From: Lucas Hrabovsky Date: Wed, 10 Jun 2015 15:33:18 -0400 Subject: [PATCH 1/2] fix(docs): First crack at 10 minute plan. --- README.md | 72 ++++++++++++++++++++++++++++++++++++++++++++ scout-check/index.js | 1 + 2 files changed, 73 insertions(+) diff --git a/README.md b/README.md index b5acbf219f2..e1c90b01a07 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,78 @@ Explore your MongoDB. 3. Run `npm install` to install dependencies 4. Run `npm start` to launch +## Modules + +The top level modules in this project are: + +
+
scout
+
+ This repo which acts as the package that glues everything together. +
+
scout-brain
+
+ Needs to be broken down into topic based models but for now, this is where + all the business logic code lives we want to share between modules running + in the browser, nodejs, or electron. +
+
scout-ui
+
+ The default Ampersand.js single-page application people actually interact with. + The WithScout mixin + connects the models to + scout-client. +
+
scout-client
+
+ Provides a clean API for scout-server + that works in the browser, nodejs, or electron. +
+
scout-server
+
+ An express.js application which provides REST and socket.io connectivity + to the mongodb node.js driver. +
+
scout-electron
+
+ Tooling for working with electron. Also provides progressive enhancement + for scout when running inside an electron instance (e.g. OS menu bindings, + window management, breakpad, autoupdates). +
+
+ +### Other Modules + +
+
scout-check
+
+ Linting, dependency checking, and more. Move to mongodb-js/gulp-mj-check +
+
scout-data
+
+ An experiment for providing some datasets on-board the app to populate + a bundled mongodb with. +
+
scout-landing-page
+
+ A metalsmith static site to use + for building Scout's landing page. Move to mongodb-js/scout-landing-page +
+
scout-style
+
+ All of the base LESS, icons, and fonts scout-ui + and scout-landing-page use. + Move to mongodb-js/scout-style so design team can completely + own this. +
+
scout-metrics
+
+ An experiment we should just kill off when we start on mixpanel/intercom tickets. +
+
+ + + [setup-osx]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#osx-setup [setup-windows]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#windows-setup [setup-linux]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#linux-setup diff --git a/scout-check/index.js b/scout-check/index.js index 99367d19bd2..bda0bfac9d4 100644 --- a/scout-check/index.js +++ b/scout-check/index.js @@ -73,6 +73,7 @@ module.exports = function(gulp, src) { // @todo: npm-check-updates + // @todo: https://www.npmjs.com/package/nsp-gulp gulp.task('check', ['format', 'lint', 'check dependencies']); }; From 26732361873bafcb6ba09a9f6a1ef86b7d1111fc Mon Sep 17 00:00:00 2001 From: Lucas Hrabovsky Date: Tue, 16 Jun 2015 17:01:08 -0400 Subject: [PATCH 2/2] fix(docs): Make links work --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index e1c90b01a07..6b195a342f7 100644 --- a/README.md +++ b/README.md @@ -14,34 +14,34 @@ Explore your MongoDB. The top level modules in this project are:
-
scout
+
scout
This repo which acts as the package that glues everything together.
-
scout-brain
+
scout-brain
Needs to be broken down into topic based models but for now, this is where all the business logic code lives we want to share between modules running in the browser, nodejs, or electron.
-
scout-ui
+
scout-ui
The default Ampersand.js single-page application people actually interact with. - The WithScout mixin - connects the models to - scout-client. + The WithScout mixin + connects the models to + scout-client.
-
scout-client
+
scout-client
- Provides a clean API for scout-server + Provides a clean API for scout-server that works in the browser, nodejs, or electron.
-
scout-server
+
scout-server
An express.js application which provides REST and socket.io connectivity to the mongodb node.js driver.
-
scout-electron
+
scout-electron
Tooling for working with electron. Also provides progressive enhancement for scout when running inside an electron instance (e.g. OS menu bindings, @@ -52,28 +52,28 @@ The top level modules in this project are: ### Other Modules
-
scout-check
+
scout-check
Linting, dependency checking, and more. Move to mongodb-js/gulp-mj-check
-
scout-data
+
scout-data
An experiment for providing some datasets on-board the app to populate a bundled mongodb with.
-
scout-landing-page
+
scout-landing-page
A metalsmith static site to use for building Scout's landing page. Move to mongodb-js/scout-landing-page
-
scout-style
+
scout-style
- All of the base LESS, icons, and fonts scout-ui - and scout-landing-page use. + All of the base LESS, icons, and fonts scout-ui + and scout-landing-page use. Move to mongodb-js/scout-style so design team can completely own this.
-
scout-metrics
+
scout-metrics
An experiment we should just kill off when we start on mixpanel/intercom tickets.