Commit Graph

160 Commits

Author SHA1 Message Date
Fish-pro
ca5fed3e2c
docs(readme): fix syntax errors in the document (#18113) 2023-01-30 12:08:47 +02:00
Orlix
17bfd43a72
Add FOSSA badge and licence analysis (#17656)
Signed-off-by: OrlinVasilev <ovasilev@vmware.com>

Signed-off-by: OrlinVasilev <ovasilev@vmware.com>
Co-authored-by: OrlinVasilev <ovasilev@vmware.com>
2022-11-02 11:01:43 +08:00
koushik-ms
5afd11015a
README.md: fix broken links to badges and Swagger editor (#16910)
* README.md: fix links to badges

the links to badges are still referring to "master" branch instead of "main". this commit fixes it.

* README.md: fix Restful API links to swagger editor

The links to swagger editor had the URL paths to the master branch which has hence been renamed. This leads to swagger editor failing to open the API links. this commit fixes that.
2022-05-31 09:40:10 +02:00
孙世军
b5a05dd1a2
Update readme (#16501)
Signed-off-by: AllForNothing <sshijun@vmware.com>
2022-03-10 14:54:43 +08:00
Simon Alling
47effb0533
docs: Link to latest/edge docs instead of 2.0.0 (#14945)
I cloned the repo, clicked a link to the build guideline in
`CONTRIBUTING.md` and copied the "Build, install and bring up Harbor
without Notary" command:

    make install GOBUILDIMAGE=golang:1.12.5 COMPILETAG=compile_golangimage

Being unfamiliar with the Harbor project, I didn't realize that said
command was for building version 2.0.0 and that I had cloned a newer,
incompatible version (2.3.0), so I just ran it and was met by errors:

    […]
    # github.com/goharbor/harbor/src/lib/errors
    ../lib/errors/errors.go:26:7: undefined: errors.As
    ../lib/errors/errors.go:28:7: undefined: errors.Is
    note: module requires Go 1.15
    # github.com/hashicorp/go-multierror
    […]
    make: *** [Makefile:369: compile_core] Error 2

It took me a while to figure out what the problem was; then I replaced
`2.0.0` with `latest` in the URL and found this command instead:

    make install GOBUILDIMAGE=golang:1.13.8 COMPILETAG=compile_golangimage

_Et voilà_ – it worked!

I figured `latest` (which currently redirects to 2.2.0) would make the
most sense for end users and `edge` (which doesn't redirect) for
contributors.

Signed-off-by: Simon Alling <alling.simon@gmail.com>
2022-03-10 13:12:55 +08:00
MinerYang
158ce0499e
update harbor codacy badge in README.md (#16277)
Signed-off-by: yminer <yminer@vmmware.com>

Co-authored-by: yminer <yminer@vmmware.com>
2022-01-26 18:10:25 +08:00
Steven Zou
10ceaf5bc5
doc(readme): use edge version for compatibility
update the doc version of the compatibility list from 2.0.0 to edge
2021-03-03 13:48:07 +08:00
Josh Soref
dfe360040b Spelling
* addition
* attribute
* auditing
* availability
* available
* bandwidth
* browser
* business
* cadence
* chartmuseum
* client
* column
* content
* demonstrate
* described
* endpoints
* facilitate
* github
* harbor
* information
* instance
* manual
* meaningful
* operation
* overridden
* password
* possible
* project
* refactor
* replication
* requires
* running
* scanned
* settings
* signup
* those
* unsigned
* vulnerability

--
Also removes trailing space from a filename

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2021-02-19 11:59:15 +08:00
jonasrosland
fbdbf1b4b4 Remove erroneous link in README
Signed-off-by: jonasrosland <jrosland@vmware.com>
2020-07-21 12:41:34 -04:00
jonasrosland
e7d1563c6b Moving docs from the harbor to the website repo
Signed-off-by: jonasrosland <jrosland@vmware.com>
2020-07-21 12:41:24 -04:00
Steven Zou
77ca209a98
chore(readme):add code scanning badge 2020-07-09 12:19:12 +08:00
xiaoyuchen9
8a3311e38e fix docs
Signed-off-by: xiaoyuchen9 <xiaoyuchen9@creditease.cn>
2020-05-29 14:51:32 +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
xaleeks
c8269e05a5 fixed install guide broken link in readme
Signed-off-by:  xaleeks <xalex@vmware.com>
Signed-off-by: xaleeks <xalex@vmware.com>
2020-05-17 04:48:22 -04:00
xaleeks
d42f8f0039
Merge pull request #11904 from grinnellian/patch-1
Correct "leveraging"
2020-05-15 00:54:46 -04:00
Ian Bone
95c7cbe49e Correct "leveraging"
Signed-off-by: Ian Bone <grinnellian@users.noreply.github.com>
2020-05-14 16:35:56 -07:00
wang yan
54706f2b1b Fix conformance badge name
It needs to use the upper case when to get the badge url

Signed-off-by: wang yan <wangyan@vmware.com>
2020-05-13 19:13:17 +08:00
wang yan
d9773248e2 add conformance test to CI
1, add a specrate git action for conformance test
2, use the OCI testing code to test Harbor master code on push

Signed-off-by: wang yan <wangyan@vmware.com>
2020-04-29 16:08:27 +08:00
Daniel Jiang
775d7d0bbb Update the link of CI badge
Signed-off-by: Daniel Jiang <jiangd@vmware.com>
2020-04-09 16:31:31 +08:00
xaleeks
0891e8877f typos fix
Signed-off-by: xaleeks <xalex@vmware.com>
2020-03-30 07:08:52 -04:00
xaleeks
df537af8d9 fixed some wording
Signed-off-by: xaleeks <xalex@vmware.com>
2020-03-30 06:33:43 -04:00
Ziming
5dd68cdc69
use codecov badge in README (#10988)
Signed-off-by: Ziming Zhang <zziming@vmware.com>
2020-03-09 22:03:24 +08:00
Daniel Jiang
0f0e27179b Remove dependency on travis-ci
Github actions work fine, we no longer needs travi-ci to trigger the
tests.
This commit removes it.

Signed-off-by: Daniel Jiang <jiangd@vmware.com>
2020-03-09 01:30:38 +08:00
lucperkins
d4709066e6 Update Swagger link
Signed-off-by: lucperkins <lucperkins@gmail.com>
2020-02-21 11:27:41 -08:00
Steven Zou
0cf3793297 doc[compatibility]:add doc ref in the README
- refer the harbor compatibility doc in the README
- add .md suffix to the README file under api/harbor

Signed-off-by: Steven Zou <szou@vmware.com>
2019-12-12 18:43:49 +08:00
Steven Zou
855b8cde18
chore[swagger]:add swagger online validation
- validate the API swagger spec with the online validation tool
- introduce the validation badge into the README
2019-12-11 20:37:59 +08:00
Steven Zou
2cd90963ef doc[scanner]:clear scanner spec related
- remove the scanner open API spec from api folder
- update README doc to remove the API reference

Signed-off-by: Steven Zou <szou@vmware.com>
2019-12-09 18:36:02 +08:00
Michael Michael
552c551f6d
Update README.md 2019-12-03 10:27:49 -06:00
Michael Michael
87e57ca356
Update README.md 2019-12-03 10:27:02 -06:00
Michael Michael
e0c049a87b
Update README.md 2019-12-03 10:23:37 -06:00
Steven Zou
4c82e4a256
remove the KubeCon San Diego event preview section
As the KubeCon has been closed.
2019-11-26 17:42:14 +08:00
Steven Zou
7b6e83090e create API folder to keep API swagger files
- create API folder
- move harbor API swagger file to API/harbor
- add scanner adapter open API swagger file to API/scanner
- update protal build Dockerfile
- update swagger explorer build command in Makefile

Signed-off-by: Steven Zou <szou@vmware.com>
2019-10-30 21:41:03 +08:00
Michael Michael
3f15a38141
Update README.md 2019-10-21 16:01:55 -07:00
DQ
aef93af21f Fix docker-compose version to 1.18.0
Signed-off-by: DQ <dengq@vmware.com>
2019-09-02 18:37:42 +08:00
DQ
131d26c0f8 Docker compose check function need updated to 1.23.0+
Signed-off-by: DQ <dengq@vmware.com>
2019-08-08 14:22:03 +08:00
Maosheng Ren
f72a2613c2
Merge pull request #6601 from royeectu/master
remove duplicate word
2019-08-02 10:24:00 +08:00
Qian Deng
b55f403679
Merge pull request #7894 from ninjadq/update_doc_4_https
Update doc for configure https
2019-06-24 14:52:12 +08:00
Henry Zhang
e619d686b6 Update readme
Signed-off-by: Henry Zhang <haininghenryzh@vmware.com>
2019-06-10 17:35:28 +08:00
Qian Deng
7a0f570e70 Update doc for configure https
update configs for https

Signed-off-by: Qian Deng <dengq@vmware.com>
2019-05-24 16:30:18 +08:00
Wang Yan
7e674ec389
bump up required docker compose version to 1.18 (#7737)
Signed-off-by: wang yan <wangyan@vmware.com>
2019-05-09 15:35:42 +08:00
Wang Yan
c028b281ea
Update required docker and docker-compose version (#7733)
Signed-off-by: wang yan <wangyan@vmware.com>
2019-05-09 13:29:07 +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
Ihor Dvoretskyi
b0fbbd5fab Harbor project contact information updated
Mailing lists updated + minor tweaks to the Slack links.

Signed-off-by: Ihor Dvoretskyi <ihor@linux.com>
2019-03-07 12:30:11 -05:00
royeectu
e5648a6b05 remove duplicate word
Signed-off-by: royeectu <royeectu@gmail.com>
2018-12-21 20:59:44 +02:00
clouderati
91a45473cb Updating README.md
Fixing minor nits in readme.

Signed-off-by: clouderati <35942204+clouderati@users.noreply.github.com>
2018-11-30 15:31:56 -05:00
James Zabala
39721662a2
Update README.md
Quick typo fix
2018-10-23 14:13:31 -04:00
James Zabala
0cacd54023
Merge pull request #6021 from wy65701436/add-nightly-badge
Add nightly badge into goharbor repo
2018-10-23 14:05:03 -04:00
clouderati
260afbad69 Updating README.md
* Tweaking langauge in demo server section of doc
* Cleaning up list of community resources

Signed-off-by: clouderati <35942204+clouderati@users.noreply.github.com>
2018-10-18 20:13:22 +00:00
clouderati
fa02521fec Updating README.md
Updating README with new link to ADOPTERS.md (in lieu of partners.md)

Signed-off-by: clouderati <35942204+clouderati@users.noreply.github.com>
2018-10-12 16:34:56 -04:00
wang yan
40a271fd32 Add nightly badge into goharbor repo
This commit is to add the nightly result badge into goharbor repo,

1,the badge could index the status of full ci which is running internally.
2,the badge is clickable, and all of the logs can be downloaded.

Signed-off-by: wang yan <wangyan@vmware.com>
2018-10-11 19:06:48 +08:00