apisix website

Sitio web de Apache Apisix®

El sitio web de Apache Apisix®

Una puerta de enlace de API de microservicios nativos de nube

Empezando

Si desea escribir un blog o solucionar algunos problemas relacionados con el blog, lea primero la guía de contribución del blog Apache Apisix.

Requisitos previos

Primero, debe instalar Git .

Entonces debes bifurcar este repositorio y clonar tu bifurcación:

 # clone your fork repo
git clone [email protected]: ${your GitHub name} /apisix-website.git

# add this repo as upstream
git remote add upstream https://github.com/apache/apisix-website.git

# default dir should be apisix-website
cd apisix-website

Comenzando en un recipiente de desarrollo

Si está utilizando el complemento VS Code , Docker y Remote - Containers , puede usarlo para comenzar rápidamente.

No, pero ¿quieres probar de esta manera? Lea el desarrollo dentro de una instalación de#de contenedor.

Luego, inicie el código VS , ejecute los Remote-Containers: Open Folder in Container...

Consejo: Para obtener detalles sobre cómo hacer esto, consulte la documentación que se desarrolla dentro de un contenedor#Inicio rápido.

Después de la inicialización, puede omitir la parte de preparación de los comandos a continuación y leer el resto directamente.

Comenzando de la manera convencional

Primero, debe instalar Node.js , hilo .

Consejo: Dado que el método de instalación puede cambiar, le recomendamos que verifique el método de instalación en el sitio web oficial correspondiente. Si encuentra algún problema, no dude en crear un problema.

Entonces puedes leer los comandos a continuación.

Comandos

Cuando encuentre que algunos comandos no se ejecutan, o no se pueden encontrar, mire el archivo Packle.json.

Esto puede deberse a que el proyecto se está actualizando rápidamente, pero el desarrollador correspondiente no encontró el tiempo para actualizar la documentación correspondiente.

Preparación

Excepto por los siguientes comandos que debe ejecutar después de descargar el proyecto por primera vez, puede intentar ejecutarlos nuevamente cuando encuentre cualquier problema.

 # 1. Install deps
yarn

# 2. Prepare necessary data
yarn prepare-data

# Tip.
# The `yarn prepare-data` command contains the following three commands
# If necessary, you can run any of the following commands individually
yarn sync-doc # Sync all project documents
yarn generate-repos-info # Generate repository information for each project
yarn generate-picked-posts # Generate frontmatter information for featured blogs

Si obtiene un Rate Limit Exceeded de GitHub, eso significa que ha alcanzado el límite de velocidad de la API de GitHub. El proyecto necesita su token de acceso personal para ilimitarlo.

Si aún no tiene uno, cree uno y ejecute el comando a continuación en su terminal (no se necesita ningún alcance para sus datos personales)

 export GITHUB_TOKEN= ${your token}

Vista previa de documentos, desarrollo

Cuando modifica un documento, blog o código de página, la vista previa en el modo de desarrollo es la más rápida.

 # Start docs part
yarn start:doc

# Tip.
# in dev, only English docs will be built
# it's a feature of docusaurus
# if you want to specify the locale,
# for example, Chinese, your should run
yarn start:doc --locale zh

# Start English Blog
yarn start:blog:en

# Start Chinese Blog
yarn start:blog:zh

# Start general docs, other pages part
yarn start:website

Edificio

Cuando desee construir o obtener una vista previa de un sitio que se vea igual que en línea, ejecute los siguientes comandos.

 # Since the local environment is slightly different from the online one,
# you must add the environment variable `preview`
preview=true yarn build
# or
yarn build:preview

# The above commands only build the site,
# to preview it locally you need the following commands
yarn serve

# You can also build and preview each part individually,
# just like in development mode
preview=true yarn build:doc && yarn serve:doc
preview=true yarn build:blog:en && yarn serve:blog:en
preview=true yarn build:blog:zh && yarn serve:blog:zh
preview=true yarn build:website && yarn serve:website

A continuación, puede modificar la documentación o el código, cometerlo y presionarlo a GitHub cuando haya terminado. Si no está familiarizado con esto, primero puede leer GitHub Flow.

Guía anticipada

Si solo desea modificar los archivos *.md , la guía anterior puede ser suficiente.

Pero si necesita desarrollarse, lea la guía a continuación.

Estructura de proyectos

Omitió algunos documentos que pueden no ser importantes.

apisix-website
├── .github
│   └── workflows # for GitHub CI, with steps to actually build the site
├── .husky # git hooks, currently only pre-commit is used
├── scripts # scripts to help build the site
├── blog
│   ├── en
│   └── zh
├── config
├── doc
└── website
    ├── articles
    ├── docs
    │   └── general # https://apisix.apache.org/docs/general/join
    ├── i18n
    │   └── zh # chinese content
    │       ├── docusaurus-plugin-content-blog # blog
    │       ├── docusaurus-plugin-content-docs # general
    │       └── docusaurus-theme-classic # translations of navbar and footer
    ├── src
    │   ├── clientModules # docusaurus feature
    │   ├── hooks # react hooks
    │   ├── pages
    │   ├── shaders
    │   └── theme # swizzled any Docs/Blog component
    ├── static
    └── docusaurus.config.js

Reconocer

Un agradecimiento especial a Docusaurus.

Licencia

Licencia de Apache 2.0