Baoyuantop commented on code in PR #11765: URL: https://github.com/apache/apisix/pull/11765#discussion_r2076902819
########## docs/en/latest/build-apisix-dev-environment-devcontainers.md: ########## @@ -0,0 +1,114 @@ +--- +id: build-apisix-dev-environment-devcontainers +title: Build development environment with Dev Containers +description: This paper introduces how to quickly start the APISIX API Gateway development environment using Dev Containers. +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +Previously, building and developing APISIX on Linux or macOS required developers to install its runtime environment and toolchain themselves, and developers might not be familiar with them. + +As it needs to support multiple operating systems and CPU ISAs, the process has inherent complexities in how to find and install dependencies and toolchains. + +:::note + +The tutorial can be used as an alternative to a [bare-metal environment](building-apisix.md) or a [macOS container development environment](build-apisix-dev-environment-on-mac.md). + +It only requires that you have an environment running Docker or a similar alternative (the docker/docker compose command is required), and no other dependent components need to be installed on your host machine. + +::: + +## Supported systems and CPU ISA + +- Linux + - AMD64 + - ARM64 +- Windows (with WSL2 supported) + - AMD64 +- macOS + - ARM64 + - AMD64 + +## Quick Setup of Apache APISIX Development Environment + +### Implementation Idea + +We use Dev Containers to build development environment, and when we open an APISIX project using the IDE, we have access to the container-driven runtime environment. + +There the etcd is ready and we can start APISIX directly. + +### Steps + +:::note + +The following uses Visual Studio Code, which has built-in integration with Dev Containers. Review Comment: Need to install the Dev Containers extension? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
