This is an automated email from the ASF dual-hosted git repository.
fenbox pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-answer-plugins.git
The following commit(s) were added to refs/heads/main by this push:
new a06f924 docs: change README, add project
a06f924 is described below
commit a06f9246c631f832d91555dcdbe9ceaacdb1d3f5
Author: Fen <[email protected]>
AuthorDate: Tue Nov 28 10:38:05 2023 +0800
docs: change README, add project
---
.asf.yaml | 7 ++++++-
README.md | 28 ++++++++++++++++------------
2 files changed, 22 insertions(+), 13 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 02bf158..4732db1 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -17,11 +17,16 @@
# NOTE: All configurations could be found here:
https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
github:
- description: "The answer plugin repository."
+ description: "The Apache Answer plugins repository."
+ homepage: https://answer.apache.org/plugins
enabled_merge_buttons:
squash: true
rebase: true
merge: false
+ features:
+ wiki: false
+ issues: true
+ projects: true
protected_branches:
main: {}
diff --git a/README.md b/README.md
index 2ba2202..0eea916 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
-# Answer Official Plugins
-> Answer Official Plugins are built to enhance the feature of
[Answer](https://github.com/apache/incubator-answer).
+# Apache Answer Official Plugins
+
+Apache Answer Official Plugins are built to enhance the feature of
[Answer](https://github.com/apache/incubator-answer).
[](https://github.com/apache/incubator-answer/blob/main/LICENSE)
[](https://golang.org/)
@@ -8,32 +9,33 @@
[](https://discord.gg/Jm7Y4cbUej)
## Types of plugin
-> Our plugin is under development and the interface definition of the plugin
can be viewed at this
[link](https://github.com/apache/incubator-answer/tree/main/plugin).
+
+Our plugin is under development and the interface definition of the plugin can
be viewed at [this
link](https://github.com/apache/incubator-answer/tree/main/plugin).
### Connector
-> The Connector plugin helps us to implement third-party login functionality.
-> For example: Google or GitHub OAuth login.
+
+The Connector plugin helps us to implement third-party login functionality.
For example: Google or GitHub OAuth login.
- [x] [OAuth2
Basic](https://github.com/apache/incubator-answer-plugins/tree/main/connector-basic)
- [x]
[GitHub](https://github.com/apache/incubator-answer-plugins/tree/main/connector-github)
- [x]
[Google](https://github.com/apache/incubator-answer-plugins/tree/main/connector-google)
### Storage (preview)
-> The Storage plugin helps us to upload files to third-party storage.
-> For example: Aliyun OSS or AWS S3.
+
+The Storage plugin helps us to upload files to third-party storage. For
example: Aliyun OSS or AWS S3.
- [ ]
[Aliyun](https://github.com/apache/incubator-answer-plugins/tree/main/storage-aliyunoss)
- [ ]
[S3](https://github.com/apache/incubator-answer-plugins/tree/main/storage-s3)
### Cache (preview)
-> Using the Cache plugin allows you to store cached data in a different
location.
-> For example: Redis or Memcached.
+
+Using the Cache plugin allows you to store cached data in a different
location. For example: Redis or Memcached.
- [ ]
[Redis](https://github.com/apache/incubator-answer-plugins/tree/main/cache-redis)
### Search (preview)
-> Support using search plugin to speed up the search of question answers.
-> For example: Elasticsearch or Meilisearch.
+
+Support using search plugin to speed up the search of question answers. For
example: Elasticsearch or Meilisearch.
- [ ]
[Elasticsearch](https://github.com/apache/incubator-answer-plugins/tree/main/search-elasticsearch)
- [ ]
[Meilisearch](https://github.com/apache/incubator-answer-plugins/tree/main/search-meilisearch)
@@ -47,9 +49,11 @@
### Importer (coming soon)
## How to build the Answer with your need plugins?
-Learn more about the plugin, please visit our docs
[answer.apache.org](https://answer.apache.org/docs/development/extending/plugin_config).
+
+Learn more about the plugin, please visit our
[docs](https://answer.apache.org/docs/plugins).
## Want to try the plugin early?
+
If you want to try it out earlier, you can use the all-in-one docker image.
Note that this image will contain **the latest version of answer** and all
official plugins, **which may not have been released yet**.
```bash
