Commit Graph

100 Commits

Author SHA1 Message Date
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
Stuart Clements
ed70e37c05 Fixed typo per pr 9372 2019-10-14 10:44:45 +02:00
Stuart Clements
67dfc5b35c Fixed typo 2019-10-11 09:16:22 +02:00
Stuart Clements
36b7310824
Documenting tag retention issue (#9215) (#9255)
* Documenting tag retention issue

* Comments from Alex

* Typo
2019-09-25 15:41:30 +02: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
f14411dcab Comments from Alex 2019-09-12 17:06:37 +02:00
Stuart Clements
5490bf395b Comment from Daniel 2019-09-12 13:45:38 +02:00
Stuart Clements
521e0f0f3f minor rewording 2019-09-11 12:13:03 +02:00
Stuart Clements
024642b05c Comment from Ziming about access to non-harbor endpoints 2019-09-11 12:10:05 +02:00
Stuart Clements
703224f30e Documented that Robo accounts can push/pull helm charts 2019-09-06 13:32:24 +02:00
Stuart Clements
f9015abbc4 Added new registry providers as replication endpoints 2019-09-06 12:39:48 +02:00
Daniel Jiang
a42ffd1b30
Merge pull request #8821 from stuclem/minor-doc-fixes
Minor doc fixes
2019-09-05 18:59:08 +08:00
Stuart Clements
ac4d280988 Removed that passwords cannot begin with #
Signed-off-by: Stuart Clements <sclements@vmware.com>
2019-09-05 09:16:38 +02:00
Stuart Clements
6da5abbc43 Minor doc corrections
Signed-off-by: Stuart Clements <sclements@vmware.com>
2019-09-05 09:16:38 +02:00
xaleeks
20383611f9 added description of master role
Signed-off-by: xaleeks <xalex@vmware.com>
2019-08-31 01:30:39 +08:00
xaleeks
010096c897 changed user_guide.md
Signed-off-by: xaleeks <xalex@vmware.com>
2019-08-29 18:47:37 +08:00
Jesse Hu
fb13d4e080 Remove unneccessary certificate options for Helm CLI
The --cert-file and --key-file options for Helm CLI
are used to identify HTTPS client, i.e. the helm CLI.
It's not mandantory and usually not needed. Most of
the users don't know how to get these two files.

Signed-off-by: Jesse Hu <huh@vmware.com>
2019-07-30 13:16:35 +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
Meina Zhou
3869c6ca56 add swagger user guide
Signed-off-by: Meina Zhou <meinaz@vmware.com>
2019-05-09 13:50:33 +08:00
wang yan
57e7305104 Update doc for Robot Accounts per review comments
Signed-off-by: wang yan <wangyan@vmware.com>
2019-04-09 17:09:20 +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
Nathan Lowe
00fab5be7b Fix link to Online GC in user guide (#6404)
Signed-off-by: Nathan Lowe <public@nlowe.me>
2018-12-02 15:37:54 +08:00
wang yan
1f947cf3c8 Remote delete repositories description and point it to gc
Signed-off-by: wang yan <wangyan@vmware.com>
2018-11-30 17:02:32 +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
65a28c044d Updates words per comments
Signed-off-by: wang yan <wangyan@vmware.com>
2018-11-26 13:56:49 +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
FangyuanCheng
8515276f98 Modify the permission image path of the developer and project manager in the user guide.
Signed-off-by: FangyuanCheng <fangyuanc@vmware.com>
2018-10-25 17:08:22 +08:00
FangyuanCheng
6d257de6b1 Change the rights of developers and project admin in user guide.
Signed-off-by: FangyuanCheng <fangyuanc@vmware.com>
2018-10-18 09:27:23 +08:00
Brett Johnson
18e76c963d Documentation typo correction
Signed-off-by: Brett Johnson <brett@sdbrett.com>

Date:      Mon Oct 8 08:41:37 2018 +1100

On branch docs
Changes to be committed:
	modified:   docs/compile_guide.md
	modified:   docs/installation_guide.md
	modified:   docs/kubernetes_deployment.md
	modified:   docs/manage_role_by_ldap_group.md
	modified:   docs/migration_guide.md
	modified:   docs/upgradetest.md
	modified:   docs/use_notary.md
	modified:   docs/user_guide.md
2018-10-08 08:45:10 +11:00
Shane Utt
5d0788ee93 Minor improvements to Helm charts documentation
Signed-off-by: Shane Utt <shaneutt@linux.com>
2018-09-19 07:20:59 -04:00
stonezdj
0906fbfabe Add document for manange role by LDAP group
Signed-off-by: stonezdj <stonezdj@gmail.com>
2018-09-07 18:39:30 +08:00
Daniel Jiang
b6a614ed01 Update the screenshots in user guide
This commit updates the screenshots in the user guide to reflect the
latest UI.
It also removes the links of video demos as they are based on earlier
builds.

Signed-off-by: Daniel Jiang <jiangd@vmware.com>
2018-08-20 17:48:01 +08:00
Steven Zou
34973f96ac Append chart repo service related sections to the agenda of user guide doc
Signed-off-by: Steven Zou <szou@vmware.com>
2018-08-15 13:36:09 +08:00
Steven Zou
880521518f
Merge pull request #5590 from steven-zou/add_chart_doc
Append chart repository server related guideline into the user guide document
2018-08-15 11:31:30 +08:00
wangyan
81c349a150 Signed-off-by: wangyan <wangyan@vmware.com>
Update the reference of docker images to goharbor

This commit is to update the reference of harbor migrator and ui builder to goharbor
2018-08-14 03:47:39 -07:00
Steven Zou
24549213ca Append chart repository server related guideline into the user guide document
Signed-off-by: Steven Zou <szou@vmware.com>
2018-08-13 14:05:28 +08:00
Wenkai Yin
4ee6f6abdf Update the user guide
This commit updates the user guide according to the comments from Louis
2018-07-25 13:04:19 +08:00
Wenkai Yin
be25d15fcc Update the user guide
Add repllication label filter to the user guide and replace a few images used in the doc
2018-07-16 18:03:31 +08:00
wangyan
f0b48575a8 Add documemt for read only 2018-04-17 22:32:37 -07:00
Deng, Qian
ddb5298ae6 Add testcase and doc for cardview 2018-04-12 19:55:46 +08:00
Wenkai Yin 79628
6c42959be2 Update user guide
Add labal management description in user guide
2018-04-11 14:04:30 +08:00
Daniel Jiang
53182ab407
Merge pull request #4439 from ronakbanka/master
Fix broken link in user doc
2018-04-08 11:07:01 +08:00
Daniel Jiang
722edc9c60
Merge pull request #3552 from Evalle/3462
[Skip CI] Add link to official docker documentation
2018-04-03 19:21:54 +08:00
Ronak Banka
22a9bbc97d Fix broken link in user doc 2018-03-31 10:19:05 +08:00
Daniel Jiang
2031f11055
Merge pull request #4193 from ywk253100/180131_user_guide
Update replication part of user guide as some UI pages are changed
2018-02-02 15:41:53 +08:00