The Wayback Machine - https://web.archive.org/web/20220108041152/https://github.com/Kong/kong/pull/8253
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

Jump to bottom

docs(*) improve docs for developer #8253

Merged
merged 5 commits into from Jan 6, 2022
Merged

docs(*) improve docs for developer #8253

merged 5 commits into from Jan 6, 2022

Conversation

@mayocream
Copy link
Member

@mayocream mayocream commented Jan 2, 2022 •
edited

Summary

Enhance Kong repo's readme/guide to be more friendly to contributors and users.

  • Add Twitter badge and GitHub discussions link to README.md
  • Improve DEVELOPER.md by adding more sections about
    • Add installing OpenResty and LuaRocks by Linux packages.
    • setup develop environment with Gojira.
@kikito kikito added core/docs and removed chore labels Jan 5, 2022
@kikito
Copy link
Member

@kikito kikito commented Jan 5, 2022

I suggest splitting this PR into two prs:

  • One for the docs changes
  • Another one (of scope chore) just for the .devcontainer
@mayocream
Copy link
Member Author

@mayocream mayocream commented Jan 6, 2022

I suggest splitting this PR into two prs:

  • One for the docs changes
  • Another one (of scope chore) just for the .devcontainer

Thanks for noticing me! I'll follow your advice!
@mayocream mayocream changed the title chore(docs) be friendly docs(*) be friendly Jan 6, 2022
@mayocream mayocream changed the title docs(*) be friendly docs(*) improve docs for developer Jan 6, 2022
@mayocream mayocream force-pushed the chore/be-friendly branch from 3f2ca0d to 46d7c90 Jan 6, 2022
@mayocream mayocream removed the pr/wip label Jan 6, 2022
@mayocream mayocream marked this pull request as ready for review Jan 6, 2022
@mayocream mayocream requested a review from Jan 6, 2022
kikito
kikito approved these changes Jan 6, 2022
View changes
Copy link
Member

@kikito kikito left a comment

Approved with one minor comment.
DEVELOPER.md Outdated Show resolved Hide resolved
@mayocream @kikito
chore(dev) remove specific versions
0ce6085 
Co-authored-by: Enrique García Cota <kikito@gmail.com>
@mayocream mayocream merged commit c0b2f17 into master Jan 6, 2022
22 of 26 checks passed
@mayocream mayocream deleted the chore/be-friendly branch Jan 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core/docs
2 participants
@mayocream @kikito