You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/05/06 10:05:48 UTC
[GitHub] [apisix-website] SkyeYoung opened a new pull request, #1068: docs: README
SkyeYoung opened a new pull request, #1068:
URL: https://github.com/apache/apisix-website/pull/1068
Fixes: #989
Changes:
refactor README
Screenshots of the change:
<!-- Add screenshots depicting the changes. -->
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] juzhiyuan commented on pull request #1068: docs: README
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on PR #1068:
URL: https://github.com/apache/apisix-website/pull/1068#issuecomment-1119601983
Hello, please resolve those errors :) https://github.com/apache/apisix-website/runs/6323027779?check_suite_focus=true
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SkyeYoung commented on pull request #1068: docs: README
Posted by GitBox <gi...@apache.org>.
SkyeYoung commented on PR #1068:
URL: https://github.com/apache/apisix-website/pull/1068#issuecomment-1119460434
Please check https://github.com/SkyeYoung/apisix-website/tree/refactor-readme to have a preview.
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SkyeYoung commented on pull request #1068: docs: README
Posted by GitBox <gi...@apache.org>.
SkyeYoung commented on PR #1068:
URL: https://github.com/apache/apisix-website/pull/1068#issuecomment-1119606412
> Hello, please resolve those errors :) [apache/apisix-website/runs/6323027779?check_suite_focus=true](https://github.com/apache/apisix-website/runs/6323027779?check_suite_focus=true)
Fixed
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] netlify[bot] commented on pull request #1068: docs: README
Posted by GitBox <gi...@apache.org>.
netlify[bot] commented on PR #1068:
URL: https://github.com/apache/apisix-website/pull/1068#issuecomment-1119456953
### <span aria-hidden="true">đź‘·</span> Deploy Preview for *apache-apisix* processing.
| Name | Link |
|---------------------------------|------------------------|
|<span aria-hidden="true">🔨</span> Latest commit | 43140fea74e3e17cb7d1e9430a625977a96fcf34 |
|<span aria-hidden="true">🔍</span> Latest deploy log | https://app.netlify.com/sites/apache-apisix/deploys/6274f2fc8c66790008b33e01 |
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] juzhiyuan merged pull request #1068: docs: README
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged PR #1068:
URL: https://github.com/apache/apisix-website/pull/1068
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] juzhiyuan commented on a diff in pull request #1068: docs: README
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on code in PR #1068:
URL: https://github.com/apache/apisix-website/pull/1068#discussion_r866705116
##########
README.md:
##########
@@ -1,20 +1,105 @@
-# Apache APISIX® Website
+<h1 style="position: relative" align="center">Apache APISIX® Website</h1>
-[<img align="right" width="150" src="./website/static/img/join-slack.png">](https://apisix.apache.org/docs/general/join)
+<div align="center">
+The website of <a href="https://github.com/apache/apisix/">Apache APISIX®</a>
-The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native microservices api gateway.
+A cloud-native microservices api gateway
Review Comment:
```suggestion
A cloud-native microservices API Gateway
```
##########
README.md:
##########
@@ -1,20 +1,105 @@
-# Apache APISIX® Website
+<h1 style="position: relative" align="center">Apache APISIX® Website</h1>
-[<img align="right" width="150" src="./website/static/img/join-slack.png">](https://apisix.apache.org/docs/general/join)
+<div align="center">
+The website of <a href="https://github.com/apache/apisix/">Apache APISIX®</a>
-The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native microservices api gateway.
+A cloud-native microservices api gateway
-If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request.
+<a href="https://apisix.apache.org/docs/general/join"><img width="150" src="./website/static/img/join-slack.png"></a>
+</div>
## Usage
+> If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first.
+
+### Preparation
+
+First, you need to install `node.js`, `yarn`, `git`.
+
+Since the installation method may change, we recommend that you check the installation method on the corresponding official website. If you encounter any problems, please feel free to create an issue.
+
+Then you should fork this repo, and clone your fork:
+
+```bash
+# clone your fork repo
+git clone git@github.com:${your GitHub name}/apisix-website.git
+
+# add this repo as upstream
+git remote add upstream https://github.com/apache/apisix-website.git
+```
+
+### Basic
+
```sh
-$ cd website
+# 1. cd
+# default dir should be apisix-website
+cd apisix-website
+
+# 2. install deps
+yarn
+
+# 3. sync docs and generate repos info
+yarn sync-doc && yarn generate-repos-info
+
+# 4. start dev mode
+yarn start
-$ yarn
+# tip.
+# in development mode, only English site will be built
+# it's a feature of docusaurus
+# if you want to specify the locale,
+# for example, Chinese, your should run
+yarn start --locale zh
-$ yarn start
+# tip.
+# if you want to preview the same site as online
+yarn build && yarn serve
```
-Thanks to [docusaurus](https://docusaurus.io/)
+Next, you can modify the documentation or code, commit it and push it to GitHub when you're done. If you're not familiar with this, you can read [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) first.
+
+### Advance
+
+If you only want to modify the `*.md` files, the above guide may be sufficient.
+
+But if you need to develop, please read the guide below.
+
+#### Project Structure
+
+Omitted some documents that may not be important.
+
+```bash
+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
+└── website # docusaurus
+ ├── articles
+ ├── blog
+ ├── config # are imported in scripts and docusaurus.config.js
+ ├── 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
+```
+
+## Acknowledge
+
+Special thanks to [docusaurus](https://docusaurus.io/).
Review Comment:
```suggestion
Special thanks to [Docusaurus](https://docusaurus.io/).
```
##########
README.md:
##########
@@ -1,20 +1,105 @@
-# Apache APISIX® Website
+<h1 style="position: relative" align="center">Apache APISIX® Website</h1>
-[<img align="right" width="150" src="./website/static/img/join-slack.png">](https://apisix.apache.org/docs/general/join)
+<div align="center">
+The website of <a href="https://github.com/apache/apisix/">Apache APISIX®</a>
-The website of [Apache APISIX®](https://apisix.apache.org/), a cloud-native microservices api gateway.
+A cloud-native microservices api gateway
-If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first. Then create a pull request.
+<a href="https://apisix.apache.org/docs/general/join"><img width="150" src="./website/static/img/join-slack.png"></a>
+</div>
## Usage
+> If you want to write a blog or fix some blog-related issues, please read [Apache APISIX Blog Contributing Guide](http://apisix.apache.org/docs/general/blog) first.
+
+### Preparation
+
+First, you need to install `node.js`, `yarn`, `git`.
Review Comment:
```suggestion
First, you need to install `Node.js`, `Yarn`, `GIt`.
```
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org