From b205a6d570d273029425bb119e2770bfb9544695 Mon Sep 17 00:00:00 2001 From: Alexander Zhukov Date: Wed, 19 Apr 2017 12:52:08 +0300 Subject: [PATCH] refactor(aio): add the docs, remove the unneeded dependencies, remove a config folder, fix a travis config --- .angular-cli.json | 4 +- .github/CONTRIBUTING.md | 2 +- .travis.yml | 10 +- CONTRIBUTING.md | 228 --- LICENSE | 2 +- config/karma.conf.js | 123 -- config/spec-bundle.js | 55 - config/webpack.test.js | 258 --- docs/config.json | 35 + .../articles/001-getting-started/index.md | 50 + .../002-installation-guidelines/index.md | 58 + .../011-changing-color-scheme/index.md | 128 ++ .../new-color-scheme.png | Bin 0 -> 290514 bytes .../articles/012-project-structure/index.md | 76 + .../articles/013-create-new-page/index.md | 137 ++ .../014-switch-to-blur-theme/index.md | 85 + docs/contents/articles/015-sidebar/index.md | 97 + docs/contents/articles/016-spinner/index.md | 61 + docs/contents/css/main.scss | 920 +++++++++ docs/contents/images/favicon.png | Bin 0 -> 1467 bytes docs/contents/images/logo.png | Bin 0 -> 1336 bytes docs/contents/images/sky-preview.png | Bin 0 -> 1754060 bytes docs/contents/images/why-design.svg | 1 + docs/contents/images/why-practices.svg | 1 + docs/contents/images/why-structure.svg | 1 + docs/contents/index.json | 4 + docs/package.json | 10 + docs/plugins/paginator.coffee | 44 + docs/templates/article.jade | 21 + docs/templates/index.jade | 59 + docs/templates/layout.jade | 44 + e2e/app.e2e-spec.ts | 14 - e2e/app.po.ts | 11 - package.json | 73 +- src/app/app.module.ts | 1 - src/app/pages/pages.routing.ts | 16 +- src/assets/service-worker.js | 1 - src/index.html | 29 +- yarn.lock | 1648 +++++++---------- 39 files changed, 2516 insertions(+), 1791 deletions(-) delete mode 100644 CONTRIBUTING.md delete mode 100644 config/karma.conf.js delete mode 100644 config/spec-bundle.js delete mode 100644 config/webpack.test.js create mode 100644 docs/config.json create mode 100644 docs/contents/articles/001-getting-started/index.md create mode 100644 docs/contents/articles/002-installation-guidelines/index.md create mode 100644 docs/contents/articles/011-changing-color-scheme/index.md create mode 100644 docs/contents/articles/011-changing-color-scheme/new-color-scheme.png create mode 100644 docs/contents/articles/012-project-structure/index.md create mode 100644 docs/contents/articles/013-create-new-page/index.md create mode 100644 docs/contents/articles/014-switch-to-blur-theme/index.md create mode 100644 docs/contents/articles/015-sidebar/index.md create mode 100644 docs/contents/articles/016-spinner/index.md create mode 100644 docs/contents/css/main.scss create mode 100644 docs/contents/images/favicon.png create mode 100644 docs/contents/images/logo.png create mode 100644 docs/contents/images/sky-preview.png create mode 100644 docs/contents/images/why-design.svg create mode 100644 docs/contents/images/why-practices.svg create mode 100644 docs/contents/images/why-structure.svg create mode 100644 docs/contents/index.json create mode 100644 docs/package.json create mode 100644 docs/plugins/paginator.coffee create mode 100644 docs/templates/article.jade create mode 100644 docs/templates/index.jade create mode 100644 docs/templates/layout.jade delete mode 100644 e2e/app.e2e-spec.ts delete mode 100644 e2e/app.po.ts delete mode 100644 src/assets/service-worker.js diff --git a/.angular-cli.json b/.angular-cli.json index b2984dde..151c380d 100644 --- a/.angular-cli.json +++ b/.angular-cli.json @@ -1,7 +1,7 @@ { "$schema": "./node_modules/@angular/cli/lib/config/schema.json", "project": { - "name": "ng2-admin-cli" + "name": "ng2-admin" }, "apps": [ { @@ -19,9 +19,9 @@ "testTsconfig": "tsconfig.spec.json", "prefix": "app", "styles": [ + "../node_modules/normalize.css/normalize.css", "../node_modules/bootstrap/scss/bootstrap.scss", "../node_modules/roboto-fontface/css/roboto/sass/roboto-fontface.scss", - "../node_modules/normalize.css/normalize.css", "../node_modules/font-awesome/scss/font-awesome.scss", "../node_modules/ionicons/scss/ionicons.scss", "../node_modules/leaflet/dist/leaflet.css", diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 25d3ce18..5704caa7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -3,4 +3,4 @@ If you're changing the structure of the repository please create an issue first ## Submitting bug reports -Make sure you are on latest changes and that you ran this command `npm run clean:install` after updating your local repository. If you can, please provide more infomation about your environment such as browser, operating system, node version, and npm version \ No newline at end of file +Make sure you are on latest changes and that you ran this command `npm run clean:install` after updating your local repository. If you can, please provide more information about your environment such as browser, operating system, node version, and npm version diff --git a/.travis.yml b/.travis.yml index 09355539..12e68ea3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,6 +5,10 @@ language: node_js node_js: - "6" +cache: + directories: + - $HOME/.cache/yarn + addons: apt: sources: @@ -15,16 +19,12 @@ addons: before_install: - curl -o- -L https://yarnpkg.com/install.sh | bash - export PATH=$HOME/.yarn/bin:$PATH - - npm config set spin false - -before_script: - - npm i -g npm@4 install: - yarn script: - - yarn run build:ci + - npm run build:ci notifications: slack: akveo:q559HckfZMSyZRb803aiLcjH diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index fa7e0998..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,228 +0,0 @@ -# Contributing to ng2-admin - -We would love for you to contribute to ng2-admin and help make it even better than it is -today! As a contributor, here are the guidelines we would like you to follow: - - - [Question or Problem?](#question) - - [Issues and Bugs](#issue) - - [Feature Requests](#feature) - - [Submission Guidelines](#submit) - - [Commit Message Guidelines](#commit) - -## Got a Question or Problem? - -Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. - -StackOverflow is a much better place to ask questions since: - -- there are thousands of people willing to help on StackOverflow -- questions and answers stay available for public viewing so your question / answer might help someone else -- StackOverflow's voting system assures that the best answers are prominently visible. - -To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow. - -If you would like to chat about the question in real-time, you can reach out via [our gitter channel][gitter]. - -## Found a Bug? -If you find a bug in the source code, you can help us by -[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can -[submit a Pull Request](#submit-pr) with a fix. - -## Missing a Feature? -You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub -Repository. If you would like to *implement* a new feature, please submit an issue with -a proposal for your work first, to be sure that we can use it. -Please consider what kind of change it is: - -* For a **Major Feature**, first open an issue and outline your proposal so that it can be -discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, -and help you to craft the change so that it is successfully accepted into the project. -* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). - -## Submission Guidelines - -### Submitting an Issue - -Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. - -We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using http://plnkr.co. Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like: - -- version of ng2-admin used -- 3rd-party libraries and their versions -- and most importantly - a use-case that fails - -A minimal reproduce scenario using http://plnkr.co/ allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem. If plunker is not a suitable way to demonstrate the problem (for example for issues related to our npm packaging), please create a standalone git repository demonstrating the problem. - -We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it. - -Unfortunately we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that don't have enough info to be reproduced. - -You can file new issues by filling out our [new issue form](https://github.com/akveo/ng2-admin/issues/new). - - -### Submitting a Pull Request (PR) -Before you submit your Pull Request (PR) consider the following guidelines: - -* Search [GitHub](https://github.com/akveo/ng2-admin/pulls) for an open or closed PR - that relates to your submission. You don't want to duplicate effort. -* Make your changes in a new git branch: - - ```shell - git checkout -b my-fix-branch master - ``` - -* Commit your changes using a descriptive commit message that follows our - [commit message conventions](#commit). Adherence to these conventions - is necessary because release notes are automatically generated from these messages. - - ```shell - git commit -a - ``` - Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. - -* Push your branch to GitHub: - - ```shell - git push origin my-fix-branch - ``` - -* In GitHub, send a pull request to `ng2-admin:master`. -* If we suggest changes then: - * Make the required updates. - * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): - - ```shell - git rebase master -i - git push -f - ``` - -That's it! Thank you for your contribution! - -#### After your pull request is merged - -After your pull request is merged, you can safely delete your branch and pull the changes -from the main (upstream) repository: - -* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: - - ```shell - git push origin --delete my-fix-branch - ``` - -* Check out the master branch: - - ```shell - git checkout master -f - ``` - -* Delete the local branch: - - ```shell - git branch -D my-fix-branch - ``` - -* Update your master with the latest upstream version: - - ```shell - git pull --ff upstream master - ``` - -## Commit Message Guidelines - -We have very precise rules over how our git commit messages can be formatted. This leads to **more -readable messages** that are easy to follow when looking through the **project history**. But also, -we use the git commit messages to **generate the ng2-admin change log**. - -### Commit Message Format -Each commit message consists of a **header**, a **body** and a **footer**. The header has a special -format that includes a **type**, a **scope** and a **subject**: - -``` -(): - - - -