From 07b6934c9dae1973526cfcc46ddb50f44af7c9f1 Mon Sep 17 00:00:00 2001 From: Steven Zou Date: Wed, 27 Sep 2017 12:33:41 +0800 Subject: [PATCH] add video demo references (both youtube and v.qq)to the readme.md and the user guide --- README.md | 7 ++ docs/img/video.png | Bin 0 -> 2451 bytes docs/user_guide.md | 10 +- src/ui_ng/CODE_OF_CONDUCT.md | 19 ---- src/ui_ng/CONTRIBUTING.md | 113 ----------------------- src/ui_ng/Clarity Seed_LICENSE_MIT.txt | 16 ---- src/ui_ng/Clarity Seed_NOTICE.txt | 8 -- src/ui_ng/README.md | 122 +------------------------ src/ui_ng/lib/README.md | 1 + 9 files changed, 20 insertions(+), 276 deletions(-) create mode 100644 docs/img/video.png delete mode 100644 src/ui_ng/CODE_OF_CONDUCT.md delete mode 100644 src/ui_ng/CONTRIBUTING.md delete mode 100644 src/ui_ng/Clarity Seed_LICENSE_MIT.txt delete mode 100644 src/ui_ng/Clarity Seed_NOTICE.txt diff --git a/README.md b/README.md index 9b6c0efc5..ca5c23e00 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,13 @@ More info on [partners and users](partners.md). ### Contribution We welcome contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a pull request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq). Contact us for any questions: harbor @vmware.com . +### Demos +* ![play](docs/img/video.png) **Content Trust** ( [youtube](https://www.youtube.com/watch?v=pPklSTJZY2E) [v.qq](https://v.qq.com/x/page/n0553fzzrnf.html) ) +* ![play](docs/img/video.png) **Role Based Access Control** ( [youtube](https://www.youtube.com/watch?v=2ZIu9XTvsC0) [v.qq](https://v.qq.com/x/page/l0553yw19ek.html) ) +* ![play](docs/img/video.png) **Vulnerability Scanning** ( [youtube](https://www.youtube.com/watch?v=K4tJ6B2cGR4) [v.qq](https://v.qq.com/x/page/s0553k9692d.html) ) +* ![play](docs/img/video.png) **Image Replication** ( [youtube](https://www.youtube.com/watch?v=1NPlzrm5ozE) [v.qq](https://v.qq.com/x/page/a0553wc7fs9.html) ) +* ![play](docs/img/video.png) **VMworld 2017** ( [youtube](https://www.youtube.com/watch?v=tI5xMe24fJ4) ) + ### License Harbor is available under the [Apache 2 license](LICENSE). diff --git a/docs/img/video.png b/docs/img/video.png new file mode 100644 index 0000000000000000000000000000000000000000..d766cdb34dec4cb39e485eaf643c51e089a18da1 GIT binary patch literal 2451 zcmY*Z2{;s58=m1JvZP@`)Lc?D%w)+j#*|3*ZH#@1FhA zID2b%W-jpSZ=RRpoz04HBpu;i? z_v8-rZCXn5bbf#BUv3}9u4c_t1{Oz;mDdxO0=CQWT_NeK_@3W}8D*%nr2rou^tk%m zq;s!rb$*#8f7etvKIxwF$M*%rd9o)&uY4FUx?3f?WZ_f$UaY#a>_%O4*3ZdvX$GrW zQ`(ushI7x+U2kiuulAL6#q_ou_gYyo`RUQcHt(Y4CnO#oeSKwaX5n~Ie?q(kpZg%* zYCVZmX8d_Rk+qsupe@F~S$K^u-%HP=R#=*?&rNODf3VpjtQe*=V@-wSGo`)Z)4upB z*08PQKEqcBZNY4As!REIi^fZ&l)IjyHO|>Nj_cQ-3<= z{!r7=pbQiZ+@Qq2Tnm1QTdqm>!GcaCYZ(fiIIIZSJ4zq+)3sjDi_!(E#%Cez*RLu! zfP$8|Z*3w@`ymZqZ#~G?bEzsmJ!ah0UViqw-cdUr^qX2O>3bK{`ZakXz8(C>{`Efd zT87T|rW8xt+=n>+95!Ef9m)^8@saw;eYu77#A~3v!LDa9!h;-(QNoK(gTMaC=)2gb zvKqDg$z8@Wx!@UN?(Ui|(lZh!ZCP6=!VTlNDLUj>)UMIjGMcnHjwESpJ?ZE8Usn+Gm~UpG~e#vYvgjpx$|a|2%F)eEiJZ(}g7^TcbKDsGYXMxAD$>_g^3 z+1CtQH}1QyR;d2sIO7t!2W^4|-L8LSCX>-v6;qBE;_+2RZW9_@7G7Y-lY~59A_#1$ zLHStQ7gqz7?iw5|C|Y1;-cq>m)b4T!I^!MQYrn|S_*(8-v2MEz$QyR1geUo^^ThHZ z4>onV2~eP%lKMoApfLPgY+S@>HSJx)`!1C{tHj+OUu`U|KjiAhC2zf&|IkaWozqTf zHZ&=HII%=|jXL?g1`wP>1(ug3Vw}!yM+*9bIMK?J3;^r~?HCYHR3c~{K+jND4~mDq z9ReGPhXn*h2I63Gc%lFe03hQK0vC^?1VG~O5d<2XPJT^8K7OMw~Bn88DjE#-q z$8_Pky4nJSHaVU^35e4skk$Ss`45i;j*KOR5-FjP1jr6=KwxAv#Z*;wN9f=2_dO}0 z=l-iiApcXApg{P}30wzu4E`^-AQib2ML3c|aRTKXev}UK2lD@7|L7p$JL3OynZGOj z5fzk*l0d@$eKwSYUH1`B06_SOwS}3hl~kRZtwx=*oZsC1)(~_>ndP&Wp+T0sLB7gh z+?ISQ2Re0;u@?ui(UcVik@I6$cFli4R+2j=Ui(h8ty{y$`S3s%w5j z)!NwDh-e%Q!D8ud?(XwbQ?wT^UT8p}muNH^Yj*a67I-(1UfR5`(N=TT8n4_aF} zRiKhgZ!fRSV zE-Wm3u167k2vZ2$Vlb4VDW>bDoAP_DGEEf0obsH8I6s-L5#}$GT+c9@$ z26v~X2HUEZ1=Z4e1%fPOWQZC3*&{x#<4qi3GS#?~%U3q$9PzXtXV}xMcSpq>UD946!yI!w5Y{Zj*fZ`4Getx`jt2|I5_j*0aEZ7 zZxd**%4RPu+DRx6VwH`yx0kXOsg`#2%#j_)*O++p_@NZN2SEbnfv5E@_Xk@TE%BIQh PbVuvc4i/clarity-seed.git - -# Navigate to the directory -cd clarity-seed - -# Set name and e-mail configuration -git config user.name "John Doe" -git config user.email johndoe@example.com - -# Setup the upstream remote -git remote add upstream https://github.com/vmware/clarity-seed.git - -# Create a topic branch for your changes -git checkout -b my-new-feature master - -# After making the desired changes, commit and push to your fork -git commit -a -s -git push origin my-new-feature -``` - -### Staying In Sync With Upstream - -When your branch gets out of sync with the master branch, use the following to update: - -``` shell -git checkout my-new-feature -git fetch -a -git pull --rebase upstream master -git push --force-with-lease origin my-new-feature -``` - -### Updating Pull Requests - -If your PR fails to pass CI, or requires changes based on code review, you'll most likely want to squash these changes into existing commits. - -If your pull request contains a single commit, or your changes are related to the most recent commit, you can amend the commit. - -``` shell -git add . -git commit --amend -git push --force-with-lease origin my-new-feature -``` - -If you need to squash changes into an earlier commit, use the following: - -``` shell -git add . -git commit --fixup -git rebase -i --autosquash master -git push --force-with-lease origin my-new-feature -``` - -Make sure you add a comment to the PR indicating that your changes are ready to review. GitHub does not generate a notification when you use git push. - -### Formatting Commit Messages - -Use this format for your commit message: - -``` - - - - -Signed-off-by: Your Name -``` - -#### Writing Guidelines - -These documents provide guidance creating a well-crafted commit message: - - * [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) - * [Closing Issues Via Commit Messages](https://help.github.com/articles/closing-issues-via-commit-messages/) - -## Reporting Bugs and Creating Issues - -You can submit an issue or a bug to our [GitHub repository](https://github.com/vmware/clarity-seed/issues). You must provide: - -* Instruction on how to replicate the issue -* The version number of Angular -* The version number of Clarity -* The version number of Node -* The browser name and version number -* The OS running the seed diff --git a/src/ui_ng/Clarity Seed_LICENSE_MIT.txt b/src/ui_ng/Clarity Seed_LICENSE_MIT.txt deleted file mode 100644 index d336bce7b..000000000 --- a/src/ui_ng/Clarity Seed_LICENSE_MIT.txt +++ /dev/null @@ -1,16 +0,0 @@ -Clarity Seed - -Copyright © 2016 VMware, Inc. All rights reserved - -The MIT license (the “License”) set forth below applies to all parts of the Clarity Seed project. You may not use this file except in compliance with the License.  - -MIT License - -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. - - diff --git a/src/ui_ng/Clarity Seed_NOTICE.txt b/src/ui_ng/Clarity Seed_NOTICE.txt deleted file mode 100644 index 7d47a3de7..000000000 --- a/src/ui_ng/Clarity Seed_NOTICE.txt +++ /dev/null @@ -1,8 +0,0 @@ -Clarity Seed - -Copyright (c) 2016 VMware, Inc. All Rights Reserved. - -This product is licensed to you under the MIT license (the "MIT License"). You may not use this product except in compliance with the MIT License. - -This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file. - diff --git a/src/ui_ng/README.md b/src/ui_ng/README.md index b7b51fa70..c4d6bccf7 100644 --- a/src/ui_ng/README.md +++ b/src/ui_ng/README.md @@ -1,121 +1,5 @@ -![Clarity](logo.png) +![Harbor UI](../../docs/img/harbor_logo.png) -Clarity Seed +Harbor UI ============ -This is a seed project for Angular 2 applications using [Clarity](https://github.com/vmware/clarity). For more information on the Clarity Design System, visit the [Clarity website](https://vmware.github.io/clarity/). - -We offer this seed project in three different build systems: - -1. **Angular-CLI version (branch: master)** - -2. Webpack 2 version (branch: webpack) - -3. SystemJS version (branch: systemjs) - -Getting started ----------------------------------- - -#### Angular-CLI version - -This seed version provides the following out of the box: - -- Angular 2 application with [clarity-icons](https://www.npmjs.com/package/clarity-icons), [clarity-ui](https://www.npmjs.com/package/clarity-ui) and [clarity-angular](https://www.npmjs.com/package/clarity-angular) included -- Development and production builds -- Unit test setup with Jasmine and Karma -- End-to-end test setup with Protractor -- SASS processor -- TSLint -- And other goodies that come with [Angular-CLI](https://github.com/angular/angular-cli#generating-and-serving-an-angular2-project-via-a-development-server) (v1.0.0-beta.20-4) - -#### Installation -*Prerequisite*: Please install Angular-CLI by following [these instructions](https://github.com/angular/angular-cli#installation). -*Note*: Even though it's optional, we recommend you to use [yarn](https://yarnpkg.com/) instead of `npm install` for installing the dependencies. - -```bash -git clone https://github.com/vmware/clarity-seed.git -cd clarity-seed - -# install the project's dependencies -yarn # or run "npm install" - -# starts the application in dev mode and watches your files for livereload -ng serve -``` - -#### Using Angular-CLI -```bash -# generating a new component -ng g component my-new-component - -# generating a new directive -ng g directive my-new-directive - -# to learn more about Angular-CLI commands and their usages -ng help -``` - -For comprehensive documentation on Angular-CLI, please see their [github repository](https://github.com/angular/angular-cli). - -#### Test and build scripts - -```bash -# running unit tests -ng test - -# running e2e tests -ng e2e - -# dev build -ng build - -# prod build -ng build --prod -``` - -## Documentation - - -For documentation on the Clarity Design System, including a list of components and example usage, see [our website](https://vmware.github.io/clarity). - - -#### Directory structure -``` -. -β”œβ”€β”€ README.md - -β”œβ”€β”€ karma.conf.js <- configuration of the test runner -β”œβ”€β”€ package.json <- dependencies of the project -β”œβ”€β”€ protractor.config.js <- e2e tests configuration -β”œβ”€β”€ src/ <- source code of the application -β”‚Β Β  β”œβ”€β”€ app/ -β”‚Β Β  β”‚Β Β  └── component/ -β”‚Β Β  β”‚Β Β  └── .component.html -β”‚Β Β  β”‚Β Β  └── .component.scss -β”‚Β Β  β”‚Β Β  └── .component.spec.ts -β”‚Β Β  β”‚Β Β  └── .component.ts -β”‚Β Β  β”‚Β Β  └── app.component.html -β”‚Β Β  β”‚Β Β  └── app.component.scss -β”‚Β Β  β”‚Β Β  └── app.component.ts -β”‚Β Β  β”‚Β Β  └── app.e2e-spec.js <- sample e2e spec file -β”‚Β Β  β”‚Β Β  └── app.module.ts -β”‚Β Β  β”‚Β Β  └── app.routing.ts -β”‚Β Β  β”‚Β Β  └── main.ts <- boostrap file for the angular app -β”‚Β Β  └── index.html -β”œβ”€β”€ angular-cli.json <- configuration of the angular-cli -β”œβ”€β”€ tsconfig.json <- configuration of the typescript project -β”œβ”€β”€ tslint.json <- sample configuration file for tslint -└── yarn.lock -``` - - -## Contributing - -The Clarity project team welcomes contributions from the community. For more detailed information, see [CONTRIBUTING.md](CONTRIBUTING.md). - -## License - -The clarity-seed project is licensed under the MIT license. - -## Feedback - -If you find a bug or want to request a new feature, please open a [GitHub issue](https://github.com/vmware/clarity-seed/issues). +This is the project based on Clarity and Angular to build Harbor UI. \ No newline at end of file diff --git a/src/ui_ng/lib/README.md b/src/ui_ng/lib/README.md index 55ca7dceb..89e903d13 100644 --- a/src/ui_ng/lib/README.md +++ b/src/ui_ng/lib/README.md @@ -1,5 +1,6 @@ # Harbor UI library **NOTES: Odd version is development version and may be not stable. Even version is release version which should be stable.** +![Harbor UI Library](../../../docs/img/harbor_logo.png) Wrap the following Harbor UI components into a sharable library and published as npm package for other third-party applications to import and reuse.