Build community (apache#126)

add community docs

---------

Co-authored-by: fen <[email protected]>
Co-authored-by: LinkinStars <[email protected]>

Author: 3 people

README.md

@@ -1,41 +1,54 @@
 # Website
 
-Answer official website is built using [Docusaurus 2](https://docusaurus.io/), and we use [pnpm](https://pnpm.io/) to manage dependencies.
-
-### Installation
+Answer official website is built using [Docusaurus](https://docusaurus.io/), and we use [pnpm](https://pnpm.io/) to manage dependencies.
 
+```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
 ```
 

blog/2023-05-12-what-is-q-and-a-platform-and-how-to-use-it/index.md

@@ -100,7 +100,7 @@ No matter what your Q&A platform is about, it’s always great to collect valuab
 💻 [GitHub Repo](https://github.com/apache/incubator-answer): Keep an eye on what we are up to lately on GitHub.
 📄[Documents](https://answer.apache.org/docs/): Everything you need to build your Answer Community from zero to hero.
 🐞 [Bug Report](https://github.com/apache/incubator-answer/issues): Hunt a bug? Simply report it for us to track efficiently.
-🚩[Public Roadmap](https://github.com/orgs/apache/projects/301): Feel free to drop a comment here and be a part of our roadmap!
+🚩[Public Roadmap](https://github.com/apache/incubator-answer/projects): Feel free to drop a comment here and be a part of our roadmap!
 
 ## Conclusion
 

blog/2023-06-15-answer-1.1.0-release/index.md

@@ -14,7 +14,7 @@ From 1.0 to 1.1.0, it's not just a stack-up of numbers, but a step forward for y
 ## Plugin: The New Wings to Your Answer
 
 ![Answer Supports Plugin](1.1.0release1.png)
-The most notable in this update is **the support of Plugin**. From small tweaks to big changes, you can make it happen in Answer. Read the documentation of Plugin [here](https://answer.apache.org/docs/development/extending/) before bust a move.
+The most notable in this update is **the support of Plugin**. From small tweaks to big changes, you can make it happen in Answer. Read the documentation of Plugin [here](https://answer.apache.org/docs/plugins) before bust a move.
 
 A quick example is to embrace a simplified and efficient user authentication experience with the plugin's OAuth capabilities for your Answer. Now, your community members can sign up or log in with existing accounts from social media platforms. For adding other log-in options, admin can go **Admin\>Plugins\>OAuth2Basic**, then fill in the necessary information in **OAuth2Basic**.
 

blog/2023-07-11-the-what-why-using-tags-for-online-community/index.md

@@ -44,7 +44,7 @@ In Answer, tag is a thread that connects users, content, and moderator. With mor
 Moderator can group related posts together and help organize content based on specific topics, themes, or categories.
 
 ![Game Community Built with Answer](OrganizeContent1.png)
-[![Support Community Built with Answer](OrganizeContent2.png)](../2023-07-05-how-to-build-a-help-center-with-your-users-and-answer/index.md)
+[![Support Community Built with Answer](OrganizeContent2.png)](/blog/2023/07/05/how-to-build-a-help-center-with-your-users-and-answer)
 
 2. Quick Search
 Tags make content more discoverable. In Answer, users can search for specific tags to find relevant content they are looking for.

blog/2023-09-27-celebrate-answer-first-anniversary-with-hacktoberfest-2023/index.md

@@ -43,7 +43,7 @@ Celebrate Answer’s first birthday with contributions, the more the better, no
 
 ### Vaunt Your Contribution
 
-We are partnering with [Vaunt](https://github.com/VauntDev) during Hacktoberfest to reward contributions. Our team will have an initial review of the submitted issues, and tag it with **hacktoberfest-accepted** first. Then, we will have a closer look to see whether it shares the same goals or visions with our[roadmap](https://github.com/orgs/apache/projects/301). If it’s a yes, we will add **LGTM** tag to it, and congratulations you’ll get a digital badge from us! Here's a group photo of all the badges, from top to bottom and left to right, in order: Plugin Maestro, Bug Hunter, and Visionary Architect. Earn it and show them with pride.
+We are partnering with [Vaunt](https://github.com/VauntDev) during Hacktoberfest to reward contributions. Our team will have an initial review of the submitted issues, and tag it with **hacktoberfest-accepted** first. Then, we will have a closer look to see whether it shares the same goals or visions with our[roadmap](https://github.com/apache/incubator-answer/projects). If it’s a yes, we will add **LGTM** tag to it, and congratulations you’ll get a digital badge from us! Here's a group photo of all the badges, from top to bottom and left to right, in order: Plugin Maestro, Bug Hunter, and Visionary Architect. Earn it and show them with pride.
 
 ![Answer Digital Badges for 2023](banner.png)
 
@@ -53,11 +53,11 @@ Bonus: for the top 3 accepted plugins contributions, you’ll also receive a bag
 
 ## Resources and FAQ
 
-Here's the gear you need before making a contribution, and we are always here to help ;)
+Here's the gear you need before making a contribution, and we are always here to help ;
 
-* Docs: <https://answer.apache.org/docs/>
-* Community: <https://meta.answer.dev/>
-* <[email protected]>
+* Docs: https://answer.apache.org/docs/
+* Community: https://meta.answer.dev
+* [email protected]
 
 1. How to show my digital badges on my GitHub?
 

community/about.md

@@ -0,0 +1,38 @@
+---
+slug: /about
+---
+# About
+
+As a Q&A platform software, we are committed to creating great product that let more people experience the fun and efficiency of Q&A communities, unleash the collective wisdom. As an open-source project, we also hope to embrace the Apache way, and attract more partners sharing the same goals to join our community. Let's build an inclusive and thriving open-source community together.
+
+## Roles
+
+Apache Answer aligns with the Apache Way. Based on community philosophy of Apache Foundation, our community has the following roles: users, contributors, committers, and PMCs.
+
+### Users
+
+For Apache Answer users, you can share and communicate with other users in the [community](/community). If you need help, you can refer to our [documentations](/docs) and pick the one that works for you. We encourage everyone to help each other, so when you have an answer to a question while searching, please don't hesitate to respond. We also welcome more users to join our contributor family.
+
+### Contributor
+
+Becoming a contributor means you are interested in and contribute to the project, not just code. In Answer, there are ways of contribution, and you can find out more [here](/community/contributing). As long as you contribute to the Answer project, you are a recognized Answer Contributor. If you become a valuable contributor to the project, the Project Management Committee (PMC) may invite you to become a Committer.
+
+### Committer
+
+Committers have read-write access to the code repository, have signed the Contributor License Agreement (CLA), and have an `@apache.org` email address. They can directly patch the code or documentation, and the Project Management Committee (PMC) will generally approve these changes by default, or reject them. Of course, the final decision is made by the PMC, not the committer individually.
+
+There's no set timeline or specific code contribution requirement to become a committer, long-term active contributors are typically considered strong candidates. The Apache Software Foundation embraces diverse contributions, so anyone who supports the community and is following the CoPDoC (Contributing to Apache Projects by Doing the Right Thing) is a potential candidate for committership.
+
+As a committer, you'll play a crucial role in shaping the project's future. You'll review and merge code changes, test and vote on release candidates, engage in product discussions, and continue to contribute in various ways. If a committer is active and has made significant contributions to the community, they may be invited to join the Project Management Committee (PMC).
+
+### PMC (Project Management Committee)
+
+A project management committee (PMC) is a committee of the Apache Software Foundation charged with [responsibility and governance](https://www.apache.org/foundation/governance/pmcs.html) for their top level project. The PMC is the vehicle through which decision-making power and responsibility for oversight devolves to developers.
+
+While committers on a project have the ability to update the code, only the PMC as a body has the authority to vote on formal releases of the project's software. The PMC is also responsible for voting in new committers and PMC members to the project, and following other policies as outlined in this [document](https://www.apache.org/dev/pmc.html#policy).
+
+## Reference
+
+- https://community.apache.org/contributors
+- https://community.apache.org/contributors/becomingacommitter.html
+- https://www.apache.org/dev/pmc.html

community/contributing/contributing.md

@@ -0,0 +1,85 @@
+---
+slug: /contributing
+---
+
+# Contributing
+
+Thanks for your interest in contributing to Apache Answer, hopefully, this document makes the process for contributing clear.
+
+The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Building Welcoming Communities](https://opensource.guide/building-community/)
+
+## Code of conduct
+
+Apache Answer has adopted a Code of Conduct that we expect project participants to adhere to. Please read the [full text](https://www.apache.org/foundation/policies/conduct.html) so that you can understand what actions will and will not be tolerated.
+
+## Get involved
+
+Apache Answer is an open source project built by passionate users, contributors, and PMC members. We are committed to creating an open and inclusive community, and we welcome everyone to join us in embracing the Apache way and building open source together.
+
+Anyone can contribute to Answer. In addition to contributing code, there are many other ways to get involved, such as:
+
+##### Using Answer
+
+- Getting started with Answer is easy. Just follow our [Getting Started Guide](/docs/installation) to see if everything works as expected.
+- If not, you can [create an issue](/community/issues) to report a bug or suggest an improvement.
+
+##### Triaging issues and pull requests
+
+- Ask for more information if you believe the [issues](/community/issues) does not provide all the details required to solve it.
+- Suggest [labels](https://github.com/apache/incubator-answer/labels) that can help categorize issues.
+- Flag issues that are stale or that should be closed.
+- Ask for test plans and review code.
+
+##### Contributing code
+
+- Claim the issue if you find one that you can solve. Create a [pull request](/community/pull-request) to submit your changes.
+- Issues labeled as [`good first issue`](https://github.com/apache/incubator-answer/labels/good%20first%20issue) are great for getting started.
+
+##### Improving documentations
+
+- If you find any typos, grammar, or errors when reading our [docs](/docs), simply click on "Edit this page" and make edits on GitHub.
+
+##### Develop plugins
+
+- Extend the functionality of Answer with plugins.
+- There are features that users are expecting, and you can claim or create your needs with [develop and submit](/community/plugins).
+
+##### Helping with version releases
+
+- Help us make Answer even better by testing new candidate releases and voting on [[email protected]](https://lists.apache.org/[email protected]).
+- If you don't find any problems, give it a `+1 (non-binding)` upvote.
+- If you find a problem, give it a `-1 (non-binding)` downvote.
+
+##### Contributing translations
+
+- If you are fluent in a language other than English, you can help us translate Answer into other languages using [Crowdin](https://crowdin.com/project/answer).
+- Please refer to the [Contributing Translations Guide](/community/translation) for more information.
+
+##### Helping with support
+
+- You can be of great help by helping other users on [Answer Meta](https://meta.answer.dev).
+- Reply and solve the questions in the [Mailing List](/community/#mailing-list).
+
+##### Promoting Answer
+
+- Share Answer on Social Media
+- Share your story with Answer to more people
+- Join our meetup, forum, etc.
+
+##### Others
+
+- Got new ideas? All contributions are very welcome.
+- If you think you need help planning your contribution, please [reach us](/community/#others) and let us know you are looking for a bit of help.
+
+## Development process
+
+Answer uses [GitHub](https://github.com/apache/incubator-answer) as its source of truth. The core team will be working directly there. All changes will be public from the beginning.
+
+All pull requests will be checked by the continuous integration system, GitHub actions. There are unit tests, and much more.
+
+### Branch organization
+
+Answer has one primary branch `main` and we use feature branches with deploy previews to deliver new features with pull requests.

community/contributing/development.md

@@ -0,0 +1,50 @@
+---
+slug: /development
+---
+
+# Development
+
+## Frontend
+
+### Installation
+
+1. Ensure you have [node](https://nodejs.org/en) and [pnpm](https://pnpm.io/installation) installed.
+2. After cloning the repository, run the following command. This will install all dependencies as well as build all local packages.
+
+  ```shell
+  $ cd ./ui
+  $ pnpm install
+  ```
+
+3. To start a development server, run `pnpm start`. now, your browser should already open automatically, and autoload `http://localhost:3000`. you can also manually visit it.
+4. To switch API, you can modify the `ui/.env.development` file and then re-run pnpm start. If you're just using it yourself, we recommend creating a `.env.development.local` file that defines the address of the api you're going to use.
+
+### Code conventions
+
+- **Most important: Look around.** Match the style you see used in the rest of the project. This includes formatting, naming files, naming things in code, naming things in documentation, etc.
+- We do have Prettier (a formatter) and ESLint (a syntax linter) to catch most stylistic problems. If you are working locally, you can run  `pnpm lint` and `pnpm prettier` to fix most code formatting.
+- **No runtime errors** Before submitting the code, please ensure that there will be no errors when running locally. This will greatly reduce the workload of review.
+
+
+## Backend
+
+### Installation
+
+1. Ensure you have [golang](https://go.dev/doc/install) installed.
+2. After cloning the repository, run the following command for build.
+
+  ```shell
+  $ go mod download
+  $ go run cmd/answer/main.go init -C ./answer-data
+  ```
+
+3. Visit `http://localhost/` to see the installation page and complete the installation. 
+
+4. Run the following command to start the server.
+  ```shell
+  $ go run cmd/answer/main.go run -C ./answer-data
+  ```
+
+### Code conventions
+
+We recommend that you follow [uber's Golang Guidelines](https://github.com/uber-go/guide) code style.