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.

Sign up for GitHub

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: add docs for building apisix development environment in Docker #10899

Merged
merged 11 commits into from
Feb 5, 2024
Merged

docs: add docs for building apisix development environment in Docker #10899

merged 11 commits into from
Feb 5, 2024

Conversation

Vacant2333
Copy link
Contributor

Description

add the docs for build apisix developer enviorment

Related issue: #10784

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@kayx23 kayx23 self-requested a review February 2, 2024 03:27
@Vacant2333
Copy link
Contributor Author

@kayx23 which category do u think will be batter? Developerment?

Vacant2333 added 2 commits February 2, 2024 11:59
kayx23
kayx23 reviewed Feb 2, 2024
View reviewed changes
docs/en/latest/config.json Outdated Show resolved Hide resolved
@kayx23 kayx23 changed the title docs: add the docs for build apisix developer enviorment docs: add docs for building apisix development environment in Docker Feb 2, 2024
Vacant2333 added 2 commits February 2, 2024 14:31
update comments
c9993b9 
Signed-off-by: Vacant2333 <[email protected]>
add license and update config.json
4cd8c28 
Signed-off-by: Vacant2333 <[email protected]>
@Vacant2333
Copy link
Contributor Author

hi @kayx23 can u help me take a look

fix comments
871e48d 
Signed-off-by: Vacant2333 <[email protected]>
@Vacant2333
Copy link
Contributor Author

@kayx23 hi! whats the next step of this pr? do u have more comments, thanks!

AlinsRan
AlinsRan previously approved these changes Feb 5, 2024
View reviewed changes
membphis
membphis reviewed Feb 5, 2024
View reviewed changes
docs/assets/images/develop-apisix-dev.png Outdated
Copy link
Member

Choose a reason for hiding this comment

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

remove this images, change it to text

docs/zh/latest/build-apisix-dev-environment-in-docker.md Outdated
#
-->

如果你希望快速的在你的系统上构建和开发 APISIX，你可以参考本教程。
Copy link
Member

Choose a reason for hiding this comment

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

mainly for Mac Os users, not others

docs/zh/latest/build-apisix-dev-environment-in-docker.md Outdated
### 启动和停止 APISIX

```shell
make run
Copy link
Member

Choose a reason for hiding this comment

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

we'd better call them, in this way docker exec ... ...

example/build-dev-image.dockerfile Outdated
RUN apt install -y cpanminus make
RUN cpanm --notest Test::Nginx

RUN apt install -y sudo git gawk curl
Copy link
Member

Choose a reason for hiding this comment

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

add vim

fix comments
6cb017a 
Signed-off-by: Vacant2333 <[email protected]>
Simplify docker exec commands
e65ec5f 
Signed-off-by: Vacant2333 <[email protected]>
membphis
membphis reviewed Feb 5, 2024
View reviewed changes
Copy link
Member

@membphis membphis left a comment

Choose a reason for hiding this comment

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

LGTM, only one hint

example/build-dev-image.dockerfile Show resolved Hide resolved
membphis
membphis approved these changes Feb 5, 2024
View reviewed changes
Copy link
Member

@membphis membphis left a comment

Choose a reason for hiding this comment

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

LGTM

@shreemaan-abhishek shreemaan-abhishek merged commit abc86a5 into apache:master Feb 5, 2024
50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlinsRan AlinsRan AlinsRan approved these changes

@shreemaan-abhishek shreemaan-abhishek shreemaan-abhishek approved these changes

@membphis membphis membphis approved these changes

@Revolyssup Revolyssup Awaiting requested review from Revolyssup

@monkeyDluffy6017 monkeyDluffy6017 Awaiting requested review from monkeyDluffy6017

@kayx23 kayx23 Awaiting requested review from kayx23

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Vacant2333 @membphis @kayx23 @shreemaan-abhishek @AlinsRan