apisix website

Site Web Apisix®

Le site Web d'Apache Apisix®

Une passerelle API Microservices-Native Cloud-Native

Commencer

Si vous souhaitez rédiger un blog ou résoudre certains problèmes liés au blog, veuillez d'abord lire le guide de contribution du blog Apisix Blog.

Pré-requis

Tout d'abord, vous devez installer Git .

Ensuite, vous devriez fourrer ce dépôt et cloner votre fourchette:

 # 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

Débutant dans un conteneur de développement

Si vous utilisez le plugin VS Code , Docker et Remote - Containers , vous pouvez l'utiliser pour commencer rapidement.

Non, mais vous voulez essayer de cette façon? Veuillez lire le développement à l'intérieur d'une installation de conteneurs.

Ensuite, Démarrez vs Code , exécutez le Remote-Containers: Open Folder in Container... Commande.

Conseil: Pour plus de détails sur la façon de procéder, consultez la documentation se développant à l'intérieur d'un conteneur # Start rapide.

Après l'initialisation, vous pouvez ignorer la partie de préparation des commandes ci-dessous et lire directement le reste.

Début de la manière conventionnelle

Tout d'abord, vous devez installer Node.js , le fil .

Conseil: Étant donné que la méthode d'installation peut changer, nous vous recommandons de vérifier la méthode d'installation sur le site officiel correspondant. Si vous rencontrez des problèmes, n'hésitez pas à créer un problème.

Ensuite, vous pouvez lire les commandes ci-dessous.

Commandes

Lorsque vous constatez que certaines commandes ne s'exécutent pas ou ne sont pas trouvées, consultez le fichier package.json.

Cela peut être dû au fait que le projet est mis à jour rapidement, mais le développeur correspondant n'a pas trouvé le temps de mettre à jour la documentation correspondante.

Préparation

À l'exception des commandes suivantes que vous devez exécuter après avoir téléchargé le projet pour la première fois, vous pouvez essayer de les exécuter à nouveau lorsque vous rencontrez des problèmes.

 # 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 vous obtenez une Rate Limit Exceeded de GitHub, cela signifie que vous avez atteint la limite de taux de l'API GitHub. Le projet a besoin de votre jeton d'accès personnel pour le détendre.

Si vous n'en avez pas déjà un, créez-en un et exécutez la commande ci-dessous dans votre terminal (aucune portée à vos données personnelles n'est nécessaire)

 export GITHUB_TOKEN= ${your token}

Prévisualisation des documents, développement

Lorsque vous modifiez un document, un blog ou un code de page, l'aperçu en mode de développement est le plus rapide.

 # 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

Bâtiment

Lorsque vous souhaitez créer ou prévisualiser un site qui ressemble à la même chose en ligne, exécutez les commandes suivantes.

 # 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

Ensuite, vous pouvez modifier la documentation ou le code, le commettre et le pousser vers GitHub lorsque vous avez terminé. Si vous n'êtes pas familier avec cela, vous pouvez d'abord lire Github Flow.

Guide d'avance

Si vous souhaitez seulement modifier les fichiers *.md , le guide ci-dessus peut être suffisant.

Mais si vous avez besoin de développer, veuillez lire le guide ci-dessous.

Structure du projet

Omis certains documents qui peuvent ne pas être importants.

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

Reconnaître

Un merci spécial à Docusaurus.

Licence

Licence Apache 2.0