Skip to content

Conversation

@soulbird
Copy link
Contributor

Fixes: #5

@soulbird soulbird requested a review from spacewander April 26, 2022 09:40
@codecov-commenter
Copy link

codecov-commenter commented Apr 26, 2022

Codecov Report

Merging #45 (91afd15) into main (1ca16a2) will decrease coverage by 0.17%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main      #45      +/-   ##
==========================================
- Coverage   62.73%   62.55%   -0.18%     
==========================================
  Files          16       16              
  Lines        1127     1127              
==========================================
- Hits          707      705       -2     
- Misses        356      357       +1     
- Partials       64       65       +1     
Impacted Files Coverage Δ
internal/core/storer/etcd.go 66.07% <0.00%> (-1.20%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1ca16a2...91afd15. Read the comment docs.

@juzhiyuan juzhiyuan changed the title chore: add readme docs: added README Apr 26, 2022
Copy link

@pottekkat pottekkat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you make sure that the headings and the sentences follow the sentence case? See: https://apisix.apache.org/docs/general/documentation-style-guide

README.md Outdated

The following figure is the topology diagram of APISIX-Seed deployment.

![apisix-seed overview](docs/assets/images/apisix-seed%20overview.png)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need to use relative paths? The image is not being shown on the preview.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite understand what you mean, this is a relative path. You want me to change to:

![apisix-seed overview](./docs/assets/images/apisix-seed%20overview.png)

?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. This is what I see on the preview now:

Screenshot 2022-04-27 at 4 16 47 PM

@soulbird soulbird requested a review from spacewander April 27, 2022 10:28
@soulbird
Copy link
Contributor Author

cc @navendu-pottekkat review again pls, thank you

@pottekkat
Copy link

pottekkat commented Apr 28, 2022

@soulbird I still don't see the images on the preview. Is it showing properly for you?

It seems to work on the fork.

@spacewander spacewander merged commit b4d73e3 into api7:main Apr 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: need more clarification, why do we need this project

5 participants