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 ec9efca0 docs: update sidebar and support descrition, fix format
ec9efca0 is described below
commit ec9efca0e15f9f4a33c6196f303e5d0f53525f39
Author: fen <[email protected]>
AuthorDate: Thu Nov 23 11:21:46 2023 +0800
docs: update sidebar and support descrition, fix format
---
community/contributing/contributing.md | 71 +++++++++++++++++++++++++++-------
community/contributing/issues.md | 17 ++++----
community/contributing/plugins.md | 6 +--
community/contributing/translation.md | 10 ++---
community/how-to-release.md | 18 +++++----
community/support.md | 8 ++--
sidebarsCommunity.js | 17 +-------
7 files changed, 89 insertions(+), 58 deletions(-)
diff --git a/community/contributing/contributing.md
b/community/contributing/contributing.md
index 71103bac..13927990 100644
--- a/community/contributing/contributing.md
+++ b/community/contributing/contributing.md
@@ -12,29 +12,72 @@ Apache Answer has adopted a Code of Conduct that we expect
project participants
## Get involved
-There are many ways to contribute to Answer, and many of them do not involve
writing any code. Here's a few ideas to get started:
+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.
-- Simply start using Answer. Go through the [Getting
Started](/docs/installation) guide. Does everything work as expected? If not,
we're always looking for improvements. Let us know by [opening an
issue](/community/issues).
-- Look through the [open
issues](https://github.com/apache/incubator-answer/issues). Provide
workarounds, ask for clarification, or suggest labels. Help [triage
issues](#triaging-issues-and-pull-requests).
-- If you find an issue you would like to fix, [open a pull
request](/community/pull-request). Issues tagged as [Good first
issue](https://github.com/apache/incubator-answer/labels/good%20first%20issue)
are a good place to get started.
-- Read through the [Answer docs](/docs). If you find anything that is
confusing or can be improved, you can click "Edit this page" at the bottom of
most docs, which takes you to the GitHub interface to make and propose changes.
-- Take a look at the [features
requested](https://github.com/apache/incubator-answer/labels/enhancement) by
others in the community and consider opening a pull request if you see
something you want to work on.
+Anyone can contribute to Answer. In addition to contributing code, there are
many other ways to get involved, such as:
-Contributions are very welcome. If you think you need help planning your
contribution, please ping us on Twitter at
[@answerdev](https://twitter.com/answerdev) and let us know you are looking for
a bit of help.
-
-### Join Answer Meta
+**Using Answer**
-We have the `#contributing` and `#development` tags on [Answer
Meta](https://meta.answer.dev) to discuss all things about Answer development.
You can also be of great help by helping other users in the `#support` tag.
+- 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
+**Triaging issues and pull requests**
-One great way you can contribute to the project without writing any code is to
help triage issues and pull requests as they come in.
-
-- Ask for more information if you believe the issue does not provide all the
details required to solve it.
+- 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? Feel free to reach us.
+
+<!-- There are many ways to contribute to Answer, and many of them do not
involve writing any code. Here's a few ideas to get started:
+
+- Simply start using Answer. Go through the [Getting
Started](/docs/installation) guide. Does everything work as expected? If not,
we're always looking for improvements. Let us know by [opening an
issue](/community/issues).
+- Look through the [open
issues](https://github.com/apache/incubator-answer/issues). Provide
workarounds, ask for clarification, or suggest labels. Help [triage
issues](#triaging-issues-and-pull-requests).
+- If you find an issue you would like to fix, [open a pull
request](/community/pull-request). Issues tagged as [Good first
issue](https://github.com/apache/incubator-answer/labels/good%20first%20issue)
are a good place to get started.
+- Read through the [Answer docs](/docs). If you find anything that is
confusing or can be improved, you can click "Edit this page" at the bottom of
most docs, which takes you to the GitHub interface to make and propose changes.
+- Take a look at the [features
requested](https://github.com/apache/incubator-answer/labels/enhancement) by
others in the community and consider opening a pull request if you see
something you want to work on. -->
+
+Contributions are very welcome. If you think you need help planning your
contribution, please ping us on Twitter at
[@answerdev](https://twitter.com/answerdev) 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.
diff --git a/community/contributing/issues.md b/community/contributing/issues.md
index 45b3f797..ba55fd76 100644
--- a/community/contributing/issues.md
+++ b/community/contributing/issues.md
@@ -14,8 +14,6 @@ There are some repos in the Answer project, you can raise
your issue for differe
When opening a new issue, always make sure to fill out the issue template.
**This step is very important!** Not doing so may result in your issue not
being managed in a timely fashion. Don't take this personally if this happens,
and feel free to open a new issue once you've gathered all the information
required by the template.
-**Please don't use the GitHub issue tracker for questions.** If you have
questions about using Answer, you can ask them on [Answer
Meta](https://meta.answer.dev). We will do our best to answer your questions.
-
**Please don't use the GitHub issue tracker for questions.** Instead, you can
ask your questions on [Answer Meta](https://meta.answer.dev), and we'll do our
best to provide you with the answers you need.
## Bugs
@@ -23,6 +21,7 @@ When opening a new issue, always make sure to fill out the
issue template. **Thi
If you find a bug, the first thing to do is to search the issues to see if
someone has already reported it. If so, please add any additional information
as a comment on the existing issue.
If no existing issue exists, please open a new issue and fill out the issue
template completely. The more information you provide, the more likely it is
that your issue will be resolved quickly. Please include the following with
each issue:
+
- A clear description of the problem
- A screenshot of the problem (if applicable)
- Steps to reproduce the problem
@@ -32,7 +31,6 @@ If no existing issue exists, please open a new issue and fill
out the issue temp
- The operating system you are using (if the issue is backend-related)
- Any other details you think are relevant
-
## Security bugs
If you find a security bug, with that in mind, please do not file public
issues. You can follow the instructions in the [security
policy](https://github.com/apache/incubator-answer/security/policy) to report
it privately.
@@ -44,11 +42,12 @@ We appreciate your feedback and ideas. If you have a
feature request, please fil
If we think the feature request is a good idea, we'll add it to the roadmap
and set the milestone. If you want to implement it, comment on the issue, and
we'll assign it to you.
## Issues Labels
+
We use labels to categorize issues.
-- bug: Issues that are bugs.
-- enhancement: Issues that are feature requests.
-- good first issue: Issues that are good for beginners.
-- help wanted: Issues that are open to help from the community.
-- invalid: Issues that are invalid.
-- duplicate: Issues that are duplicates of other issues.
+- `bug`: Issues that are bugs.
+- `enhancement`: Issues that are feature requests.
+- `good first issue`: Issues that are good for beginners.
+- `help wanted`: Issues that are open to help from the community.
+- `invalid`: Issues that are invalid.
+- `duplicate`: Issues that are duplicates of other issues.
diff --git a/community/contributing/plugins.md
b/community/contributing/plugins.md
index b8ace527..8b7e7015 100644
--- a/community/contributing/plugins.md
+++ b/community/contributing/plugins.md
@@ -7,7 +7,7 @@ slug: /plugins
## Plugin types
-目前我们总共有三种类型的插件
+Currently we have three types of plugins:
- Backend
- Builtin plugin
@@ -72,7 +72,7 @@ This plugin is suitable for the following scenarios
1. A plug-in that can independently complete some UI functions and does not
require back-end support;
2. The code needs to be isolated to prevent confusion with the main site;
-Existing
examples：[editor-chart](https://github.com/apache/incubator-answer-plugins/blob/main/editor-chart)、[editor-formula](https://github.com/apache/incubator-answer-plugins/tree/main/editor-formula).
+Existing
examples:[editor-chart](https://github.com/apache/incubator-answer-plugins/blob/main/editor-chart)、[editor-formula](https://github.com/apache/incubator-answer-plugins/tree/main/editor-formula).
In order to simplify the development and compilation process, we use
[workspace](https://pnpm.io/next/workspaces) to manage this independent
front-end warehouse.
@@ -89,7 +89,7 @@ The **name** field in package.json is the name of the package
we add dependencie
"editor-chart" ❌
:::
-- Go to the `ui/src/plugins` directory and create a directory，such as
editor_chart, then add the components you want to develop, then modify the
`ui/src/plugins/index.ts` file to export your components; **changes here during
the release phase do not need to be submitted**.
+- Go to the `ui/src/plugins` directory and create a directory, such as
editor_chart, then add the components you want to develop, then modify the
`ui/src/plugins/index.ts` file to export your components; **changes here during
the release phase do not need to be submitted**.
```
export { default as editor_chart } from 'editor_chart';
diff --git a/community/contributing/translation.md
b/community/contributing/translation.md
index 3863e78e..725da210 100644
--- a/community/contributing/translation.md
+++ b/community/contributing/translation.md
@@ -1,17 +1,17 @@
+---
+slug: /translation
+---
# Translation
Our project is connected to [crowdin](https://crowdin.com/) for translation;
we recommend contributing translations through crowdin.
-Translate address：
+Translate project list:
- [crowdin-apache-answer](https://crowdin.com/project/answer)
- [crowdin-apache-answer-website](https://crowdin.com/project/answer-website)
-### Why recommend crowdin
+## Why recommend crowdin
1. Through crowdin, translators only need to focus on the translation work
itself, and crowdin will provide very convenient prompts;
2. No additional operations are required, such as git commands. Our
apache-answer project language file uses yaml. Some contributors are likely to
format the indentation or operate by mistake, causing some formatting errors;
-
-
-
diff --git a/community/how-to-release.md b/community/how-to-release.md
index 4f2e7140..f306904a 100644
--- a/community/how-to-release.md
+++ b/community/how-to-release.md
@@ -1,26 +1,29 @@
# How to Release
-## Apache Release Guide
-> All Apache projects are required to follow the [Apache Release
Policy](https://www.apache.org/legal/release-policy.html). This guide is
intended to help you understand the policy and how to release projects at
Apache.
+All Apache projects are required to follow the [Apache Release
Policy](https://www.apache.org/legal/release-policy.html). This guide is
intended to help you understand the policy and how to release projects at
Apache.
## Release Process
+
1. Prepare all the release artifacts.
2. Upload the release artifacts to the svn repository.
3. Verify the release artifacts.
4. Vote on the release.
## Prepare all the release artifacts
+
1. Create the RC tag in the git repository and write the release notes.
2. Build the release artifacts(bundles, source archives, etc).
3. Sign the release artifacts.
4. Create the checksums for the release artifacts.
## Upload the release artifacts to the svn repository
+
1. Create a directory for the release artifacts in the svn repository.
2. Upload the release artifacts to the svn repository.
3. Upload the KEYS file to the svn repository.
## Verify the release artifacts
+
Basic check items:
- [ ] Download links are valid.
@@ -56,15 +59,16 @@ $ for i in *.tar.gz; do echo $i; sha512sum --check
$i.sha512; done
```
## Vote on the release
-1. Send a vote email to the `[email protected]`. Incubator need to first
do a vote on their dev list and that vote requires at least 3 +1s from Answer
PPMC members.
+
+1. Send a vote email to the <[email protected]>. Incubator need to first
do a vote on their dev list and that vote requires at least 3 +1s from Answer
PPMC members.
2. Wait for at least 72 hours or until the necessary number of votes are
reached.
3. Announce the result of the vote on the dev list.
-4. If the dev vote passes, send email to the `[email protected]` to
request a vote on the general list. The incubator vote needs at least 3 +1s
from Incubator PMC members
+4. If the dev vote passes, send email to the <[email protected]> to
request a vote on the general list. The incubator vote needs at least 3 +1s
from Incubator PMC members
(binding votes).
5. Wait for at least 72 hours or until the necessary number of votes are
reached.
6. Announce the result of the vote on the dev list.
-### Vote Email Template
+### Vote email template
```text
[VOTE] Release Apache Answer(Incubating) {release-version}
@@ -116,5 +120,5 @@ Hello,
https://github.com/apache/incubator-answer#building-from-source
Thanks,
-LinkinStar
-```
\ No newline at end of file
+<YOUR NAME>
+```
diff --git a/community/support.md b/community/support.md
index 9f1cf8dc..dbcd4c53 100644
--- a/community/support.md
+++ b/community/support.md
@@ -7,19 +7,19 @@ Hey there! Welcome to Answer, a Q&A platform software. We've
got a bunch of curi
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.
-If you're still having trouble after checking our documentation and other
resources, feel free to [contact us](#none-of-the-above). Since our users and
contributors come from all over the world, so we recommend using English as
primary communication language for the best possible assistance.
+If you're still having trouble after checking our documentation and other
resources, feel free to [contact us](#others). Since our users and contributors
come from all over the world, so we recommend using English as primary
communication language for the best possible assistance.
## Answer Meta
Answer is all about questions and answers, as its official community, Answer
Meta is the best place to discuss any issues you’re having with the platform,
share experience, or help others by answering their questions. Answer Meta is
also a great way to keep track of questions and answers, and it helps to ensure
that the content is always up-to-date.
-<a href="https://meta.answer.dev"; class="btn btn-outline-primary">Discussion
forums</a>
+<a href="https://meta.answer.dev"; class="btn btn-primary"><i class="bi
bi-chat-square-text-fill me-2"></i>Discussion forums</a>
## Mailing list
We use email because it’s a great way to keep everyone in loop. Before sending
an email, you can search the mailing list archives beforehand to see if there
are any previous related discussions about your question.
-| Name | Description | Subscribe | Unsubscribe | Archive |
+| Name | Description | Subscribe | Unsubscribe | Archives |
| --- | --- | --- | --- | --- |
| <[email protected]> | Community discussion |
[Subscribe](mailto:[email protected]) |
[Unsubscribe](mailto:[email protected]) |
[Archives](https://lists.apache.org/[email protected]) |
| <[email protected]> | Code repo update |
[Subscribe](mailto:[email protected]) |
[Unsubscribe](mailto:[email protected]) |
[Archives](https://lists.apache.org/[email protected]) |
@@ -30,8 +30,6 @@ Kindly note that, if you're not subscribed to the mailing
list, you won't receiv
For the latest news about Answer, [follow @answerdev on
Twitter](https://twitter.com/answerdev) and the [official blog](/blog) on this
website. You can also reach us via [Discord](https://discord.gg/a6PZZbfnFx),
but due to the size of our team, we can't guarantee an instant response. Thanks
for your understanding.
-## None of the above
-
If you don't find what you're looking for, please use the form below to submit
your request. We'll try and get back to you as soon as possible.
<!-- iframe https://share.hsforms.com/1eE-U5pv9T16uulukBWPejAe14rk -->
diff --git a/sidebarsCommunity.js b/sidebarsCommunity.js
index 75b374b0..f11d282d 100644
--- a/sidebarsCommunity.js
+++ b/sidebarsCommunity.js
@@ -12,23 +12,10 @@ module.exports = {
collapsed: false,
items: [
'contributing/issues',
- {
- type: 'category',
- label: 'Development',
- link: {
- type: 'doc',
- id: 'contributing/development',
- },
- collapsed: true,
- items: [
- 'contributing/backend',
- 'contributing/frontend',
- 'contributing/development',
- 'contributing/plugins',
- ],
- },
+ 'contributing/development',
'contributing/pull-request',
'contributing/plugins',
+ 'contributing/translation',
],
},
'how-to-release',
