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 11b13904 docs: move how-to-release to /contributing directory
11b13904 is described below
commit 11b13904d0569749c7fa5dbc16dfcfa65b90cf01
Author: fen <[email protected]>
AuthorDate: Thu Nov 23 12:09:22 2023 +0800
docs: move how-to-release to /contributing directory
---
community/{ => contributing}/how-to-release.md | 6 +++-
community/contributing/issues.md | 2 +-
community/contributing/plugins.md | 44 ++++++++++++++------------
sidebarsCommunity.js | 2 +-
4 files changed, 30 insertions(+), 24 deletions(-)
diff --git a/community/how-to-release.md
b/community/contributing/how-to-release.md
similarity index 98%
rename from community/how-to-release.md
rename to community/contributing/how-to-release.md
index f306904a..e21869b8 100644
--- a/community/how-to-release.md
+++ b/community/contributing/how-to-release.md
@@ -1,8 +1,12 @@
+---
+slug: /how-to-release
+---
+
# How to Release
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
+## Release process
1. Prepare all the release artifacts.
2. Upload the release artifacts to the svn repository.
diff --git a/community/contributing/issues.md b/community/contributing/issues.md
index ba55fd76..1fb78ef3 100644
--- a/community/contributing/issues.md
+++ b/community/contributing/issues.md
@@ -41,7 +41,7 @@ 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
+## Issues labels
We use labels to categorize issues.
diff --git a/community/contributing/plugins.md
b/community/contributing/plugins.md
index 8b7e7015..e8cb358b 100644
--- a/community/contributing/plugins.md
+++ b/community/contributing/plugins.md
@@ -11,7 +11,7 @@ Currently we have three types of plugins:
- Backend
- Builtin plugin
-- Standard ui plugin
+- Standard UI plugin
## Registration and activation of plugins
@@ -27,7 +27,7 @@ It is not so different from React component, this plugin is
more suitable for th
### How to develop builtin plugin
-- **Familiar with the directory structure**. Go to the
`ui/src/plugins/builtin` directory and create a directory, such as Demo. Then
refer to the existing plugins to create the necessary files to start
development.
+1. **Familiar with the directory structure**. Go to the
`ui/src/plugins/builtin` directory and create a directory, such as Demo. Then
refer to the existing plugins to create the necessary files to start
development.
```txt
// ui/src/plugins/builtin
@@ -43,7 +43,7 @@ It is not so different from React component, this plugin is
more suitable for th
├── services.ts (api)
```
-- Export the plugins you have just defined in the plugins list file
`plugins/builtin/index.ts`
+2. Export the plugins you have just defined in the plugins list file
`plugins/builtin/index.ts`
```ts
import Demo from './Demo'
@@ -54,7 +54,7 @@ It is not so different from React component, this plugin is
more suitable for th
};
```
-- Now you can use the PluginRender component to render the just-defined plugin
where you want it!
+3. Now you can use the PluginRender component to render the just-defined
plugin where you want it!
```ts
<PluginRender
@@ -63,38 +63,40 @@ It is not so different from React component, this plugin is
more suitable for th
/>
```
-- **Publish plugin**: initiate the PR process normally and describe the
plug-in function and scope of influence in detail.
+4. **Publish plugin**: initiate the PR process normally and describe the
plug-in function and scope of influence in detail.
-## Standard ui plugin
+## Standard UI plugin
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.
-### How to develop standard ui plugin
+### How to develop standard UI plugin
-- First, refer to the two existing warehouses above to familiarize yourself
with the basic configuration and component export methods.
+1. First, refer to the two existing warehouses above to familiarize yourself
with the basic configuration and component export methods.
-:::info
+ :::info
-The **name** field in package.json is the name of the package we add
dependencies to; do not use ‘-’ to connect this field naming, please use ‘_’;
for example:
+ The **name** field in package.json is the name of the package we add
dependencies to; do not use ‘-’ to connect this field naming, please use ‘_’;
for example:
-"editor_chart" ✅
+ "editor_chart" ✅
-"editor-chart" ❌
+ "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**.
+ :::
-```
-export { default as editor_chart } from 'editor_chart';
-```
-- 运行 `pnpm pre-install`, and 重新运行 `pnpm start`, 最后在你需要加载这个插件的页面调用一下 PluginKit
中 changePluginActiveStatus 方法来激活插件。 **Changes here during the release phase do
not need to be submitted**.
+2. 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**.
+
+ ```ts
+ export { default as editor_chart } from 'editor_chart';
+ ```
+
+3. 运行 `pnpm pre-install`, and 重新运行 `pnpm start`, 最后在你需要加载这个插件的页面调用一下 PluginKit
中 changePluginActiveStatus 方法来激活插件。 **Changes here during the release phase do
not need to be submitted**.
```ts
import PluginKit from '@/utils/pluginKit';
@@ -103,5 +105,5 @@ export { default as editor_chart } from 'editor_chart';
// @param2 boolean; is whether or not to activate the
PluginKit.changePluginActiveStatus('editor_chart', true);
```
-
-- **Publish plugin**: after the function is developed, copy your entire
plug-in folder to (incubator-answer-plugins)
[https://github.com/apache/incubator-answer-plugins], **and add `go.mod`
`[plugin_name].go` `go.sum` these three files **; then initiate a PR and wait
for review by relevant personnel; if incubator-answer If there are relevant
changes in PR, please describe the scope of impact in PR.
+
+4. **Publish plugin**: after the function is developed, copy your entire
plug-in folder to (incubator-answer-plugins)
[https://github.com/apache/incubator-answer-plugins], **and add `go.mod`
`[plugin_name].go` `go.sum` these three files**; then initiate a PR and wait
for review by relevant personnel; if incubator-answer If there are relevant
changes in PR, please describe the scope of impact in PR.
diff --git a/sidebarsCommunity.js b/sidebarsCommunity.js
index f11d282d..da4d5101 100644
--- a/sidebarsCommunity.js
+++ b/sidebarsCommunity.js
@@ -16,9 +16,9 @@ module.exports = {
'contributing/pull-request',
'contributing/plugins',
'contributing/translation',
+ 'contributing/how-to-release',
],
},
- 'how-to-release',
{
type: 'link',
href: 'https://meta.answer.dev',
