update documentation

Signed-off-by: Christopher Guindon <chris.guindon@eclipse-foundation.org>

CONTRIBUTING.md

@@ -4,15 +4,15 @@ Thanks for your interest in this project.
 
 ## Project description
 
-solstice-assets is a project to regroup assets for the Eclipse Foundation look and feel. 
+solstice-assets is a project to regroup assets for the Eclipse Foundation look and feel.
 
-* https://github.com/eclipsefdn/solstice-assets
+* https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets
 
 ## Developer resources
 
 The project maintains the following source code repositories
 
-* https://github.com/eclipsefdn/solstice-assets
+* https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets
 
 ## Eclipse Contributor Agreement
 

NOTICE.md

@@ -2,7 +2,7 @@
 
 This content is produced and maintained by the Eclipse Foundation.
 
-* Project home: https://github.com/eclipsefdn/solstice-assets
+* Project home: https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets
 
 ## Trademarks
 
@@ -28,7 +28,7 @@ SPDX-License-Identifier: EPL-2.0
 
 The project maintains the following source code repositories:
 
-* https://github.com/eclipsefdn/solstice-assets
+* https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets
 
 ## Third-party Content
 

README.md

 # solstice-assets
 
-Assets for the Eclipse Foundation look and feel called Solstice. 
+Assets for the Eclipse Foundation look and feel called Solstice.
 
 ## Getting started
 
@@ -10,20 +10,32 @@ Install dependencies, build assets and watch for changes:
 npm install && npm run drupal && npm run watch
 ```
 
+## How to use this project
+
+Make sure to require [./node_modules/eclipsefdn-solstice-assets/webpack-solstice-assets.mix.js](https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets/-/raw/master/webpack-solstice-assets.mix.js) in you webpack.mix.js to load our default configurations. You are likely to run into issues building your project without it.
+
+You also need to call `mix.EclipseFdnSolsticeAssets()` to load tmem.
+
+```js
+require('./node_modules/eclipsefdn-solstice-assets/webpack-solstice-assets.mix.js');
+let mix = require('laravel-mix');
+mix.EclipseFdnSolsticeAssets();
+```
+
+
 ## Contributing
 
-1. [Fork](https://help.github.com/articles/fork-a-repo/) the [EclipseFdn/solstice-assets](https://github.com/EclipseFdn/solstice-assets) repository
-2. Clone repository: `git clone https://github.com/[your_github_username]/solstice-assets.git`
-3. Install dependencies: `cd solstice-assets && npm install`
-4. Watch for changes (Optional): `npm run watch`
-5. Create your feature branch: `git checkout -b my-new-feature`
-6. Commit your changes: `git commit -m 'Add some feature' -s`
-7. Push feature branch: `git push origin my-new-feature`
-8. Submit a pull request
+1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [solstice-assets](https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets/) repository
+2. Clone repository: `git clone https://gitlab.eclipse.org/[your_github_username]/solstice-assets.git`
+3. Create your feature branch: `git checkout -b my-new-feature`
+4. Commit your changes: `git commit -m 'Add some feature' -s`
+5. Push feature branch: `git push origin my-new-feature`
+6. Submit a merge request
+7.
 
 ## Bugs and feature requests
 
-Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/eclipsefdn/solstice-assets/issues/new).
+Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets/-/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=).
 
 ## Maintainers
 
@@ -65,4 +77,4 @@ In development, we test in modern browsers to ensure the general use-case is met
 
 ## Copyright and license
 
-Copyright 2018 the [Eclipse Foundation, Inc.](https://www.eclipse.org) and the [solstice-assets authors](https://github.com/eclipsefdn/solstice-assets/graphs/contributors). Code released under the [Eclipse Public License Version 2.0 (EPL-2.0)](https://github.com/eclipsefdn/solstice-assets/blob/src/LICENSE).
+Copyright 2018 the [Eclipse Foundation, Inc.](https://www.eclipse.org) and the [solstice-assets authors](https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets/-/graphs/master). Code released under the [Eclipse Public License Version 2.0 (EPL-2.0)](https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets/-/raw/master/README.md).

docs/index.html

@@ -223,7 +223,7 @@
           <li><a href="http://fortawesome.github.io/Font-Awesome/">Font Awesome</a> v4.7.0 </li>
           <li><a href="https://feathericons.com/">Feather</a> v4.7.0 </li>
           <li><a href="http://jquery.com/">jQuery</a> v2.1.1</li>
-          <li><a href="https://github.com/chrisguindon/solstice-assets">Solstice Assets</a> (Less files &amp; images)</li>
+          <li><a href="https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets">Solstice Assets</a> (Less files &amp; images)</li>
           <li><a href="http://geedmo.github.io/yamm3/">Yamm3</a> (Yet another megamenu for Bootstrap 3)</li>
         </ul>
         <h2>Getting Started</h2>

package.json

@@ -6,11 +6,11 @@
   "license": "EPL-2.0",
   "version": "0.0.172",
   "bugs": {
-    "url": "https://github.com/EclipseFdn/solstice-assets/issues"
+    "url": "https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets/-/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/eclipsefdn/solstice-assets.git"
+    "url": "git@gitlab.eclipse.org:eclipsefdn/it/webdev/solstice-assets.git"
   },
   "browserslist": "last 5 version, > 0.2%, not dead, IE 11",
   "scripts": {