Merge pull request atom#19772 from atom/migrate-welcome-package

➡ Migrate core package 'welcome' into ./packages

package.json

@@ -163,7 +163,7 @@
     "typescript-simple": "1.0.0",
     "update-package-dependencies": "https://www.atom.io/api/packages/update-package-dependencies/versions/0.13.1/tarball",
     "vscode-ripgrep": "^1.2.5",
-    "welcome": "https://www.atom.io/api/packages/welcome/versions/0.36.9/tarball",
+    "welcome": "file:packages/welcome",
     "whitespace": "https://www.atom.io/api/packages/whitespace/versions/0.37.7/tarball",
     "winreg": "^1.2.1",
     "wrap-guide": "https://www.atom.io/api/packages/wrap-guide/versions/0.41.0/tarball",
@@ -226,7 +226,7 @@
     "timecop": "0.36.2",
     "tree-view": "0.228.0",
     "update-package-dependencies": "0.13.1",
-    "welcome": "0.36.9",
+    "welcome": "file:./packages/welcome",
     "whitespace": "0.37.7",
     "wrap-guide": "0.41.0",
     "language-c": "0.60.18",

packages/README.md

@@ -97,7 +97,7 @@ See [RFC 003](https://github.com/atom/atom/blob/master/docs/rfcs/003-consolidate
 | **timecop** | [`atom/timecop`][timecop] | [#18272](https://github.com/atom/atom/issues/18272) |
 | **tree-view** | [`atom/tree-view`][tree-view] |  |
 | **update-package-dependencies** | [`atom/update-package-dependencies`][update-package-dependencies] | [#18284](https://github.com/atom/atom/issues/18284) |
-| **welcome** | [`atom/welcome`][welcome] | [#18285](https://github.com/atom/atom/issues/18285) |
+| **welcome** | [`./welcome`](./welcome) | [#18285](https://github.com/atom/atom/issues/18285) |
 | **whitespace** | [`atom/whitespace`][whitespace] |  |
 | **wrap-guide** | [`atom/wrap-guide`][wrap-guide] | [#18286](https://github.com/atom/atom/issues/18286) |
 
@@ -166,6 +166,5 @@ See [RFC 003](https://github.com/atom/atom/blob/master/docs/rfcs/003-consolidate
 [timecop]: https://github.com/atom/timecop
 [tree-view]: https://github.com/atom/tree-view
 [update-package-dependencies]: https://github.com/atom/update-package-dependencies
-[welcome]: https://github.com/atom/welcome
 [whitespace]: https://github.com/atom/whitespace
 [wrap-guide]: https://github.com/atom/wrap-guide

packages/welcome/.gitignore

@@ -0,0 +1 @@
+node_modules

packages/welcome/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2014 GitHub Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/welcome/README.md

@@ -0,0 +1,3 @@
+## Welcome package
+
+Opens a welcome editor with helpful information the very first time Atom is opened and the usage statistics opt-in.

packages/welcome/docs/events.md

@@ -0,0 +1,36 @@
+# Events specification
+
+This document specifies all the data (along with the format) which gets sent from the Welcome package to the GitHub analytics pipeline. This document follows the same format and nomenclature as the [Atom Core Events spec](https://github.com/atom/metrics/blob/master/docs/events.md).
+
+## Counters
+
+Currently the Welcome package does not log any counter events.
+
+## Timing events
+
+Currently the Welcome package does not log any timing events.
+
+## Standard events
+
+#### Welcome package shown
+
+* **eventType**: `welcome-v1`
+* **metadata**
+
+  | field | value |
+  |-------|-------|
+  | `ea` | `show-on-initial-load`
+
+
+#### Click on links
+
+* **eventType**: `welcome-v1`
+* **metadata**
+
+  | field | value |
+  |-------|-------|
+  | `ea` | link that was clicked
+
+(There are many potential values for the `ea` param, e.g: `clicked-welcome-atom-docs-link`,`clicked-welcome-atom-org-link`, `clicked-project-cta`, `clicked-init-script-cta`, ...).
+
+