Commit Graph

116 Commits

Author SHA1 Message Date
Will Sun
ca036a2164
Merge pull request #11618 from kensipe/master
Returning imgs needed for README.md
2020-05-20 12:59:56 +08:00
Steven Zou
8af243d8b2 doc(readme):update readme to fix broken content
- add architecture section
- update API section
- remove additional tools section
- update compatibility list section
- update the relevant compatibility list document
- add OCI confirmance testing report link
- update broken image paths in readme

Signed-off-by: Steven Zou <szou@vmware.com>
2020-05-18 23:30:34 +08:00
Maosheng Ren
310df76bf5
Merge pull request #11850 from bitsf/doc_retention_2.0
feat(doc) update retention/replication doc for 2.0
2020-05-13 22:34:03 +08:00
Ziming Zhang
653015b86c feat(doc) update retention/replication doc
Signed-off-by: Ziming Zhang <zziming@vmware.com>
2020-05-13 21:48:46 +08:00
He Weiwei
bcbab31fe1
Merge pull request #11897 from heww/vulns-scanning-docs
docs(scan): add docs about image index scanning
2020-05-13 19:06:58 +08:00
xaleeks
7095a2fef5
Merge pull request #11902 from heww/helm-chart-docs
docs(helm-chart): add docs for OCI-compatible helm charts
2020-05-13 06:35:27 -04:00
Wang Yan
5b177da2f8
update document of tag immutability for v2.0.0 (#11893)
Signed-off-by: wang yan <wangyan@vmware.com>
2020-05-13 18:16:58 +08:00
He Weiwei
b984a01269 docs(helm-chart): add docs for OCI-compatible helm charts
Signed-off-by: He Weiwei <hweiwei@vmware.com>
2020-05-13 08:57:19 +00:00
He Weiwei
1c06b90575 docs(scan): add docs about image index scanning
Signed-off-by: He Weiwei <hweiwei@vmware.com>
2020-05-13 07:57:59 +00:00
xaleeks
a5f1116acb
Merge pull request #11898 from mmpei/offical-webhook-user-guide
Update webhook user guide
2020-05-13 03:41:26 -04:00
peimingming
c51bed7a63 Update webhook user guide
Signed-off-by: peimingming <peimingming@corp.netease.com>
2020-05-13 14:27:38 +08:00
Wang Yan
36fa498319
update document of garbage collection for v2.0.0 (#11890)
Signed-off-by: wang yan <wangyan@vmware.com>
2020-05-13 13:51:55 +08:00
Maosheng Ren
6f04b59aa5
Merge pull request #11880 from reasonerjt/doc-add-repositories
Add md file to document repositories
2020-05-13 10:12:53 +08:00
Daniel Jiang
219375b0aa Add md file to document repositories
Signed-off-by: Daniel Jiang <jiangd@vmware.com>
2020-05-12 01:31:44 +08:00
xaleeks
e6fa7e1545 changes
Signed-off-by: xaleeks <xalex@vmware.com>
2020-05-10 23:29:21 -04:00
AllForNothing
c50cbbf3cc Modify doc and fix some ui bugs
Signed-off-by: AllForNothing <sshijun@vmware.com>
2020-05-11 09:39:33 +08:00
jonasrosland
48966f4364 Move 1.10 docs into the main docs folder
Signed-off-by: jonasrosland <jrosland@vmware.com>
2020-04-21 00:29:25 +08:00
Ken Sipe
f87cbf2991
returning imgs needed for README.md
Signed-off-by: Ken Sipe <kensipe@gmail.com>
2020-04-14 15:20:21 -05:00
lucperkins
7beeba6889 Begin restructuring Markdown and file names
Signed-off-by: lucperkins <lucperkins@gmail.com>
2020-01-24 14:59:18 -08:00
vvnotw
fae6181b84 doc[compatibility]:add new scanner to compatibility list
Signed-off-by: vvnotw <for_vv@foxmail.com>
2019-12-25 15:46:35 +08:00
Stuart Clements
26905baca2
Doc updates for 1.10 (#10029)
* Updated doc to include Limited Guest

* Added example for limited guest.

* Updated vulnerability scanning docs for 1.10.

* Updated GC docs to reflect new position in UI

* Updated project quota doc to reflect new position in UI

* Added some doc about tag immutability

* Fixed index

* Formatting

* Added new replication endpoints

* Added project quota webhook

* Review comments from Alex

* Clarified Clair requirement for additional scanners

* Some formatting and edits in vulnerability section

* Updated tag retention doc to reflect new UI

* Updated tag immutability to reflect new UI

* New screencaps

* Updated robot accounts doc for new UI and rewrote

* Formatting

* Updated webhooks doc for new UI

* Formatting

* Updated Logs doc for new UI

* Formatting

* New screencaps

* Added tag immutability to permissions document

* Corrected immutability permissions

* Added explanation for project quotas

* Fixed typo

* Linked to new compatibility list document

* Comments from Alex

* Comments from Steven and Wang

* Removed mention of the ellipsis in project menu

* Reverting some screencaps to remove ellipsis

* Reverted log screencaps to remove ellipsis

* Minor rewording

* Fixed caps

* More cap fixing

* Added info about self-registration, rewrote db auth doc

* Attempting to document *.asc key

* Added that negligible vulnerabilities are ignored, rewrote

* Formatting

* Added scanner permissions to table

* Clarified labelling and replication

* Rewrote replication docs

* Formatting

* Typo

* Rearranged content

* Updated ASC key docs

* formatting

* Minor rewording

* Rewrote LDAP section

* minor edits

* Added OIDC groups, rewrote OIDC docs

* formatting

* Mentioned memberof for OIDC.

* Comments from steven

* Added info about insecure registries

* Added tag immutability example

* Removed UAA from install guide

* Cleaned up headers

* More clean up of headers

* Recommended not to use UAA

* Added user-generated CLI secret

* Adding stray screencap
2019-12-12 18:35:30 +01:00
Steven Zou
0d8e29424b
Merge pull request #9042 from steven-zou/doc/replication_metrics
doc[compatibility]:provide compatibility doc
2019-12-11 22:11:32 +08:00
Steven Zou
3d32dfef5e doc[compatibility] provide compatibility doc
- list all the supported replicaiton adapters
- list all the verified OIDC providers including the ones verified by the end users
- list all the pluggable scanners

Signed-off-by: Steven Zou <szou@vmware.com>
2019-12-11 21:24:29 +08:00
Steven Zou
3fbf47b330
Merge pull request #9534 from zhill/add_anchore_adopter
Adds Anchore logo in ADOPTERS.md
2019-10-23 20:49:39 +08:00
Steven Zou
62451a57d9
add missing component in the harbor arch diagram
- no code contained
- for 1.10
2019-10-19 10:09:51 +08:00
Zach Hill
4f4326b3d6 Adds Anchore logo in ADOPTERS.md
Signed-off-by: Zach Hill <zach@anchore.com>
2019-10-18 10:05:21 -07:00
Steven Zou
4a59c9acfa
update the architecture diagram of Harbor -1.10
no code contained
2019-10-18 19:57:36 +08:00
Steven Zou
76a2a9864c
upload the diagram of the Harbor architecture
No code contained
2019-10-18 17:50:50 +08:00
Wenkai Yin
ac7364fd11 Update the adopters documentation
Update the adopters documentation

Signed-off-by: Wenkai Yin <yinw@vmware.com>
2019-09-26 14:26:48 +08:00
Stuart Clements
0470b334c6
Adding docs about webhooks, tag retention, CVE whitelists and project quotas (#8869)
* Adding docs about webhooks

* Fixed title

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Comments from Alex

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Adding placeholder for tag retentionl correct # of endpoints

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Added doc for tag retention

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Added JSON example for webhooks

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Added global webhook setting and error handling

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Comments from mmpei

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Comment from Alex

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Comment about concurrency from Alex

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Comment from steven about ** wildcard

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Comments from Steven on examples

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Added screen cap to edit retention rule

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Fixing indentation

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Clarified quotas

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Added doc for quotas

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Removing fullstops

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Fixed image links

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Documenting CVE whitelists

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Fix cut n paste error

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Adding images `

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Another cut n paste error

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Typos

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Tidied the language somewhat

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Comments from Wang Yan

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Completed unfinished sentence.

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Comments from Alex

Signed-off-by: Stuart Clements <sclements@vmware.com>

* Comment from Alex on artifact counts

* Replaced "artifact" with "tag" as appropriate

* Updated CVE whitelist button label

* Comments from He Weiwei

* Review comments
2019-09-16 14:54:40 +02:00
Daniel Jiang
89b8dfc508
Merge pull request #9004 from stuclem/robot-helm
Documented that Robo accounts can push/pull helm charts
2019-09-16 11:34:16 +08:00
Stuart Clements
703224f30e Documented that Robo accounts can push/pull helm charts 2019-09-06 13:32:24 +02:00
Stuart Clements
ddc602b036 Another screencap 2019-09-06 12:45:24 +02:00
Stuart Clements
ef1a22d55d Took better screenshot 2019-09-06 12:42:59 +02:00
Stuart Clements
f9015abbc4 Added new registry providers as replication endpoints 2019-09-06 12:39:48 +02:00
Henry Zhang
e619d686b6 Update readme
Signed-off-by: Henry Zhang <haininghenryzh@vmware.com>
2019-06-10 17:35:28 +08:00
Daniel Jiang
db0afeedef Update user guide for OIDC authentication
Signed-off-by: Daniel Jiang <jiangd@vmware.com>
2019-05-16 03:50:34 +08:00
Wenkai Yin
0582e6763d Update the replication part in user guide (#7746)
Update the replication part in user guide. Fixes #7133, fixes #7601

Signed-off-by: Wenkai Yin <yinw@vmware.com>
2019-05-10 18:26:27 +08:00
Wenkai Yin
ae3b75d33b
Merge pull request #7657 from zhoumeina/swagger_guide
add swagger user guide
2019-05-10 10:30:05 +08:00
Meina Zhou
3869c6ca56 add swagger user guide
Signed-off-by: Meina Zhou <meinaz@vmware.com>
2019-05-09 13:50:33 +08:00
Haining Henry Zhang
b5412b9476 update documents (#7727)
Signed-off-by: Henry Zhang <haininghenryzh@vmware.com>
2019-05-09 09:49:30 +08:00
wang yan
8be3129f11 Add document for robot account
Signed-off-by: wang yan <wangyan@vmware.com>
2019-03-11 17:13:14 +08:00
Frank Kung
aa1c1ce489 update user_guide about the build history.
Signed-off-by: Frank Kung <kfanjian@gmail.com>
2018-12-18 15:50:01 +08:00
陈德
7e9a12fb22 Update user guide for retag function
Signed-off-by: 陈德 <chende@caicloud.io>
2018-12-06 09:23:40 +08:00
Daniel Jiang
ec32603917
Merge pull request #6242 from ninjadq/update_user_guide
Update user guide screenshot
2018-12-02 22:48:03 -08:00
Daniel Jiang
6a127ba201
Merge pull request #6312 from wy65701436/update-gc-document
add document for gc
2018-11-30 18:18:27 +08:00
Steven Zou
bba81cfc93 Restore the missing picture of CONTRIBUTING.md file
Signed-off-by: Steven Zou <szou@vmware.com>
2018-11-28 17:40:51 +08:00
Qian Deng
7724d1fd5a Update user guide screenshot
update the screenshots in user guide
update document in user guide

Signed-off-by: Qian Deng <dengq@vmware.com>
2018-11-27 15:43:17 +08:00
wang yan
d138587478 add document for gc
This commit is to update user guide to introduce the handbook of GC

Signed-off-by: wang yan <wangyan@vmware.com>
2018-11-20 18:38:12 +08:00
Dan Kohn
4be4618705
Use updated Harbor logo
Signed-off-by: Dan Kohn <dan@dankohn.com>

Logo is from https://github.com/cncf/artwork
2018-11-18 15:56:53 -05:00