Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): improve developer docs #4227

Merged

Conversation

pouriyajamshidi
Copy link
Contributor

@pouriyajamshidi pouriyajamshidi commented Apr 30, 2022

Summary

fix typo in e2e test tips link inside DEVELOPER.md file and add unzip in the list of CLI tools section

Full changelog

  • fix typo in e2e test tips link inside DEVELOPER.md file
  • add unzip to the command line tool section of DEVELOPER.md to prevent make dev/tools command failure if the system does not have unzip installed

Signed-off-by: Pouriya [email protected]

Changelog: skip

fix typo in e2e test tips link inside `DEVELOPER.md` file

Signed-off-by: Pouriya <[email protected]>
@pouriyajamshidi pouriyajamshidi requested a review from a team as a code owner April 30, 2022 10:54
@codecov-commenter
Copy link

codecov-commenter commented Apr 30, 2022

Codecov Report

Merging #4227 (e9a661f) into master (b14dd18) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4227   +/-   ##
=======================================
  Coverage   55.64%   55.65%           
=======================================
  Files         933      933           
  Lines       56251    56251           
=======================================
+ Hits        31301    31304    +3     
+ Misses      22462    22460    -2     
+ Partials     2488     2487    -1     
Impacted Files Coverage Δ
pkg/plugins/runtime/gateway/route/sorter.go 66.66% <0.00%> (-5.13%) ⬇️
pkg/core/resources/model/rest/resource.go 71.60% <0.00%> (-1.24%) ⬇️
pkg/core/resources/manager/cache.go 85.71% <0.00%> (+2.59%) ⬆️
pkg/defaults/components.go 85.71% <0.00%> (+3.57%) ⬆️
pkg/core/tokens/default_signing_key.go 72.22% <0.00%> (+5.55%) ⬆️

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 b14dd18...e9a661f. Read the comment docs.

@pouriyajamshidi pouriyajamshidi changed the title fix(docs): fix broken e2e test tips link fix(docs): update broken e2e test tips link Apr 30, 2022
@pouriyajamshidi pouriyajamshidi changed the title fix(docs): update broken e2e test tips link fix(docs): improve developer docs May 1, 2022
add unzip to the CLI section and fix typo in e2e test tips link

Signed-off-by: Pouriya <[email protected]>
@lahabana
Copy link
Contributor

lahabana commented May 2, 2022

Thx for the contrib!

@lahabana lahabana merged commit 22f2093 into kumahq:master May 2, 2022
parkanzky pushed a commit that referenced this pull request May 6, 2022
- fix typo in e2e test tips link inside `DEVELOPER.md` file
- add unzip to the CLI section and fix typo in e2e test tips link

Signed-off-by: Pouriya <[email protected]>
Signed-off-by: Paul Parkanzky <[email protected]>
lukidzi pushed a commit that referenced this pull request May 11, 2022
- fix typo in e2e test tips link inside `DEVELOPER.md` file
- add unzip to the CLI section and fix typo in e2e test tips link

Signed-off-by: Pouriya <[email protected]>
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.

4 participants