You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@answer.apache.org by li...@apache.org on 2023/11/21 09:41:05 UTC
(incubator-answer-website) branch build-community updated (fcbb5e37 -> bcd80b22)
This is an automated email from the ASF dual-hosted git repository.
linkinstar pushed a change to branch build-community
in repository https://gitbox.apache.org/repos/asf/incubator-answer-website.git
from fcbb5e37 docs: add translation contribute docs
new 54a2bff6 docs(development): add backend development description
new bcd80b22 docs(release): add how to release docs
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
community/contributing/backend.md | 11 ----
community/contributing/development.md | 38 ++++++++---
community/how-to-release.md | 120 ++++++++++++++++++++++++++++++++++
sidebarsCommunity.js | 1 +
4 files changed, 149 insertions(+), 21 deletions(-)
create mode 100644 community/how-to-release.md
(incubator-answer-website) 01/02: docs(development): add backend development description
Posted by li...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
linkinstar pushed a commit to branch build-community
in repository https://gitbox.apache.org/repos/asf/incubator-answer-website.git
commit 54a2bff67615193f2d97050eb79c62281033f29e
Author: LinkinStars <li...@foxmail.com>
AuthorDate: Tue Nov 21 17:40:09 2023 +0800
docs(development): add backend development description
---
community/contributing/backend.md | 11 ----------
community/contributing/development.md | 38 ++++++++++++++++++++++++++---------
2 files changed, 28 insertions(+), 21 deletions(-)
diff --git a/community/contributing/backend.md b/community/contributing/backend.md
index fc10263d..e7141993 100644
--- a/community/contributing/backend.md
+++ b/community/contributing/backend.md
@@ -154,18 +154,7 @@ alt="repo-unit-test-coverage-rate"
width="300"
/>
-### Translation
-All our translations are placed in the i18n directory.
-
-1. If you find that the corresponding key in the language you are using does not have a translation, you can submit your translation.
-2. If you want to submit a new language translation, please add your language to the `i18n.yaml` file.
-
-### Features or Plugin
-1. We developed the features for the plan based on the [roadmap](https://github.com/orgs/apache/projects/301). If you are suggestions for new functions, please confirm whether they have been planned.
-2. Plugins will be available in the future, so stay tuned.
-
## Notice
-### Modify the database table structure is very hard
Usually, we don't want to modify the field that already exists in the database table.
If you need to change it, follow these rules.
1. Adding fields is better than modifying them.
diff --git a/community/contributing/development.md b/community/contributing/development.md
index ff0be18a..fc5c6a14 100644
--- a/community/contributing/development.md
+++ b/community/contributing/development.md
@@ -4,12 +4,6 @@ slug: /development
# Development
-## Backend
-
-### Installation
-
-### Code conventions
-
## Frontend
### Installation
@@ -18,15 +12,39 @@ slug: /development
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
+ $ cd ./ui
+ $ pnpm install
```
-1. 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.
-2. 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.
+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.
\ No newline at end of file
(incubator-answer-website) 02/02: docs(release): add how to release docs
Posted by li...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
linkinstar pushed a commit to branch build-community
in repository https://gitbox.apache.org/repos/asf/incubator-answer-website.git
commit bcd80b22fd8732a2987e63552566df383bb41d0f
Author: LinkinStars <li...@foxmail.com>
AuthorDate: Tue Nov 21 17:40:55 2023 +0800
docs(release): add how to release docs
---
community/how-to-release.md | 120 ++++++++++++++++++++++++++++++++++++++++++++
sidebarsCommunity.js | 1 +
2 files changed, 121 insertions(+)
diff --git a/community/how-to-release.md b/community/how-to-release.md
new file mode 100644
index 00000000..4f2e7140
--- /dev/null
+++ b/community/how-to-release.md
@@ -0,0 +1,120 @@
+# 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.
+
+## 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.
+- [ ] Checksums and PGP signatures are valid.
+- [ ] Source code distributions have correct names matching the current release.
+- [ ] LICENSE and NOTICE files are correct for each Answer repo.
+- [ ] All files have license headers if necessary.
+- [ ] No unlicensed compiled archives bundled in source archive.
+
+### How to verify the signatures
+
+```shell
+# download KEYS
+$ curl https://dist.apache.org/repos/dist/dev/incubator/answer/KEYS > KEYS
+
+# import KEYS and trust the key
+$ gpg --import KEYS
+$ gpg --edit-key joyqi@apache.org
+gpg> trust
+gpg> 5
+gpg> y
+gpg> quit
+
+# verify the signature
+$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
+```
+
+### How to verify the checksums
+
+```shell
+# verify the checksums
+$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
+```
+
+## Vote on the release
+1. Send a vote email to the `dev@answer.apache.org`. 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 `general@incubator.apache.org` 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
+
+```text
+[VOTE] Release Apache Answer(Incubating) {release-version}
+
+Hello,
+
+ This is a call for vote to release Apache Answer(Incubating) version {release-version}.
+
+ The vote thread:
+ https://lists.apache.org/thread/xxxxxx
+
+ Vote Result:
+ https://lists.apache.org/thread/xxxxxx
+
+ The release candidates:
+ https://dist.apache.org/repos/dist/dev/incubator/answer/{release-version}/
+
+ Release notes:
+ https://github.com/apache/incubator-answer/releases/tag/{release-version}
+
+ Git tag for the release:
+ https://github.com/apache/incubator-answer/releases/tag/{release-version}
+
+ Git commit id for the release:
+ https://github.com/apache/incubator-answer/commit/xxxxxxxxxxx
+
+ Keys to verify the Release Candidate:
+ https://dist.apache.org/repos/dist/dev/incubator/answer/KEYS
+
+ The vote will be open for at least 72 hours or until the necessary number of votes are reached.
+
+ Please vote accordingly:
+
+ [ ] +1 approve
+ [ ] +0 no opinion
+ [ ] -1 disapprove with the reason
+
+ Checklist for reference:
+
+ [ ] Download links are valid.
+ [ ] Checksums and PGP signatures are valid.
+ [ ] Source code distributions have correct names matching the current release.
+ [ ] LICENSE and NOTICE files are correct for each Answer repo.
+ [ ] All files have license headers if necessary.
+ [ ] No unlicensed compiled archives bundled in source archive.
+
+ To compile from the source, please refer to:
+
+ https://github.com/apache/incubator-answer#building-from-source
+
+Thanks,
+LinkinStar
+```
\ No newline at end of file
diff --git a/sidebarsCommunity.js b/sidebarsCommunity.js
index 0d375002..75b374b0 100644
--- a/sidebarsCommunity.js
+++ b/sidebarsCommunity.js
@@ -31,6 +31,7 @@ module.exports = {
'contributing/plugins',
],
},
+ 'how-to-release',
{
type: 'link',
href: 'https://meta.answer.dev',