search

X-lab2017 / open-digger

Open source analysis tools
https://open-digger.cn
Apache License 2.0
290 stars 86 forks source link

[Docs] Typo at `open-digger/README.md` #1272

Closed tc2000731 closed 1 year ago

tc2000731 commented 1 year ago

Description

https://github.com/X-lab2017/open-digger/blob/b35b78d030ebb644a4029b95fc4e96fd3a7b1b33/README.md?plain=1#L9

According to comment originally posted by @xgdyp in https://github.com/X-lab2017/open-digger/issues/1256#issuecomment-1510182393. I suppose I can fix this typo by making changes as below.

- ... or user `login` to get your data. 
+ ... or `user login` to get your data.
tc2000731 commented 1 year ago

/self-assign

tc2000731 commented 1 year ago

@xgdyp Hi, I'm new to this repo, I hope I'm doing everything correctly. Feel free to review my process and PR #1273 if you have time.

tc2000731 commented 1 year ago

@xgdyp I find this expression confusing after reading the whole text.

All implemented metrics are open for anyone to use, you can find the data with the following URLs, The root URL of OpenDigger static data is https://oss.x-lab.info/open-digger/github/ right now since we only have GitHub data for now, just replace the org/repo or user login to get your data.

In the example of https://oss.x-lab.info/open-digger/github/, I believe open-digger/github is not a pattern of org/repo, since there is no open-digger organization.

I suggest we should come up with a clearer pattern for users to follow, such as https://oss.x-lab.info/<owner>/<metric>/. Or please offer me an example of what org/repo should be like in a url to metrics.

tc2000731 commented 1 year ago

@xgdyp How do you think my version of rewriting is?

All implemented metrics are open for anyone to use, you can find the data with the following URLs, The root URL of OpenDigger static data is https://oss.x-lab.info/open-digger/github/ right now since we only have GitHub data for now, just replace the org/repo or user login to get your data.

Rewrite:

All implemented metrics data can be accessed from https://oss.x-lab.info/open_digger/github/<owner>/<repo>/<file>, for example, https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/openrank.json.

https://oss.x-lab.info/open-digger/github/ is the root URL of OpenDigger static data and only GitHub data is supported for now. Replace the <owner>/<repo>/<file> to get your data. All of the available metric files are listed in the example table below.