This is an automated email from the ASF dual-hosted git repository.
fenbox pushed a commit to branch build-community
in repository https://gitbox.apache.org/repos/asf/incubator-answer-website.git
The following commit(s) were added to refs/heads/build-community by this push:
new d292e7da docs: add directory description
d292e7da is described below
commit d292e7da28bf3bebbd44b8309103cbb132efbba0
Author: fen <[email protected]>
AuthorDate: Fri Nov 24 15:50:05 2023 +0800
docs: add directory description
---
README.md | 32 ++++++++++++++++++++++----------
community/contributing/how-to-release.md | 10 +++++-----
community/support.mdx | 2 +-
docs/introduction.md | 11 ++++-------
4 files changed, 32 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 79b1a86c..efe61bf7 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,53 @@
# Website
-Answer official website is built using [Docusaurus 2](https://docusaurus.io/),
and we use [pnpm](https://pnpm.io/) to manage dependencies.
+Answer official website is built using [Docusaurus](https://docusaurus.io/),
and we use [pnpm](https://pnpm.io/) to manage dependencies.
-### Installation
+```txt
+Directory description
+|- blog # blog posts
+|- community # community docs
+|- docs # using docs
+|- i18n # translation files
+|- plugins # plugin config
+|- src # components, custom css and pages
+`- static # static files
```
-// pnpm version should > 8
+
+## Installation
+
+```shell
+# pnpm version should > 8
pnpm i
```
-### Local Development
+## Local Development
-```
+```shell
pnpm start
```
This command starts a local development server and opens up a browser window.
Most changes are reflected live without having to restart the server.
-### Build
+## Build
-```
+```shell
pnpm build
```
This command generates static content into the `build` directory and can be
served using any static contents hosting service.
-### Deployment
+## Deployment
Using SSH:
-```
+```shell
USE_SSH=true pnpm deploy
```
Not using SSH:
-```
+```shell
GIT_USER=<Your GitHub username> pnpm deploy
```
diff --git a/community/contributing/how-to-release.md
b/community/contributing/how-to-release.md
index ea851554..6670f42e 100644
--- a/community/contributing/how-to-release.md
+++ b/community/contributing/how-to-release.md
@@ -78,17 +78,17 @@ $ for i in *.tar.gz; do echo $i; sha512sum --check
$i.sha512; done
### Vote email template
```text
-[VOTE] Release Apache Answer(Incubating) {release-version}
+[VOTE] Release Apache Answer (Incubating) {release-version}
Hello,
- This is a call for vote to release Apache Answer(Incubating) version
{release-version}.
+ This is a call for vote to release Apache Answer (Incubating) version
{release-version}.
The vote thread:
- https://lists.apache.org/thread/xxxxxx
+ https://lists.apache.org/thread/{id}
Vote Result:
- https://lists.apache.org/thread/xxxxxx
+ https://lists.apache.org/thread/{id}
The release candidates:
https://dist.apache.org/repos/dist/dev/incubator/answer/{release-version}/
@@ -100,7 +100,7 @@ Hello,
https://github.com/apache/incubator-answer/releases/tag/{release-version}
Git commit id for the release:
- https://github.com/apache/incubator-answer/commit/xxxxxxxxxxx
+ https://github.com/apache/incubator-answer/commit/{id}
Keys to verify the Release Candidate:
https://dist.apache.org/repos/dist/dev/incubator/answer/KEYS
diff --git a/community/support.mdx b/community/support.mdx
index ff04a7ba..af761123 100644
--- a/community/support.mdx
+++ b/community/support.mdx
@@ -4,7 +4,7 @@ slug: /
# Support
-Hey there! Welcome to Answer, a Q&A platform software. We've got a bunch of
curious and helpful users who are always willing to give a hand.
+Hey there! Welcome to Apache Answer, a Q&A platform software. We've got a
bunch of curious and helpful users who are always willing to give a hand.
If you're having trouble finding an answer to your question, check out our
[community](#answer-meta), [documentations](/docs),
[issues](/community/issues), or [mailing list](#mailing-list). If you find a
question that you can answer, please do! Even if your answer isn't perfect, our
volunteers will be happy to help you fill in the gaps.
diff --git a/docs/introduction.md b/docs/introduction.md
index 1acd8550..0088e269 100644
--- a/docs/introduction.md
+++ b/docs/introduction.md
@@ -4,10 +4,9 @@ slug: /
# Introduction
-Answer helps you to build a community between your users and your team.
-It's a place where you can share your knowledge and help your users to solve
their problems.
+Apache Answer helps you to build a community between your users and your team.
It's a place where you can share your knowledge and help your users to solve
their problems.
-Main features:
+## Features
- **Questions and answers** - Ask questions and get answers from your users
and your team.
- **Content organization** - Organize your content into categories and tags.
@@ -19,10 +18,8 @@ Main features:
## Architecture
-### Separating the frontend and backend
+Separating the frontend and backend. Answer is a monorepo that contains both
the frontend and the backend.
-Answer is a monorepo that contains both the frontend and the backend.
-
-## UI Preview
+## Screenshot
