From 1b638c11325dab4adee4f41183ee277bc99a4e5b Mon Sep 17 00:00:00 2001
From: nuolin <lushiji@xiaohongshu.com>
Date: Mon, 4 Nov 2024 14:36:37 +0800
Subject: [PATCH] update some describe

---
 pcip/README.md                                |   4 +-
 pcip/TEMPLATE.md                              |  57 ++----------------
 .../img-{xxx}.png}                            | Bin
 3 files changed, 6 insertions(+), 55 deletions(-)
 rename pcip/static/img/{pcip-{xxx}-img-{x}.png => pcip-{xxx}/img-{xxx}.png} (100%)

diff --git a/pcip/README.md b/pcip/README.md
index 7a4761c..9de355a 100644
--- a/pcip/README.md
+++ b/pcip/README.md
@@ -39,7 +39,7 @@ Any person willing to contribute to the Apache Pulsar Java Contrib project is we
 The process works in the following way:
 
 1. Fork https://github.com/apache/pulsar-java-contrib repository (Using the fork button on GitHub).
-2. Clone the repository, and on it, copy the file `pcip/TEMPLATE.md` and name it `pcip-xxx.md`. The number `xxx` should be the next sequential number after the last contributed PCIP. You view the list of contributed PIPs (at any status) as a list of Pull Requests having a "PCIP" label. Use the link [here](https://github.com/apache/pulsar-java-contrib/pulls?q=is%3Apr+label%3APCIP+) as shortcut.
+2. Clone the repository, and on it, copy the file `pcip/TEMPLATE.md` and name it `pcip-xxx.md`. The number `xxx` should be the next sequential number after the last contributed PCIP. You view the list of contributed PIPs (at any status) as a list of Pull Requests having a "PCIP" label. Use the link [here](https://github.com/apache/pulsar-java-contrib/pulls?q=is%3Apr+%22PCIP-%22+in%3Atitle+sort%3Acreated-desc) as shortcut.
 3. Write the proposal following the section outlined by the template and the explanation for each section in the comment it contains (you can delete the comment once done).
    * If you need the diagrams, please create a folder named pcip-XXX under the [pcip/static/img](https://github.com/apache/pulsar-java-contrib/tree/master/pcip/static/img) path and put the images in.
 4. Create GitHub Pull request (PR). The PR title should be `[improve][pcip] PCIP-xxx: {title}`, where the `xxx` match the number given in previous step (file-name). Replace `{title}` with a short title to your proposal.
@@ -56,7 +56,7 @@ To speed up the development process:
 You can the view list of PCIPs previously managed by GitHub [here](https://github.com/apache/pulsar-java-contrib/tree/master/pcip)
 
 ### List of PCIPs
-1. You can view all PCIPs (besides the historical ones) as the list of Pull Requests having title starting with `[improve][pcip] PCIP-`. Here is the [link](https://github.com/apache/pulsar-java-contrib/pulls?q=is%3Apr+title%3A%22%5Bpcip%5D%5Bdesign%5D+PCIP-%22) for it.
+1. You can view all PCIPs (besides the historical ones) as the list of Pull Requests having title starting with `PCIP-`. Here is the [link](https://github.com/apache/pulsar-java-contrib/pulls?q=is%3Apr+%22PCIP-%22+in%3Atitle+sort%3Acreated-desc) for it.
     - Merged PR means the PCIP was accepted.
     - Closed PR means the PCIP was rejected.
     - Open PR means the PCIP was submitted and is in the process of discussion.
diff --git a/pcip/TEMPLATE.md b/pcip/TEMPLATE.md
index 01da888..e74a326 100644
--- a/pcip/TEMPLATE.md
+++ b/pcip/TEMPLATE.md
@@ -103,63 +103,14 @@ When adding a new endpoint to the REST API, please make sure to document the fol
   This is the place to document the errors.
 -->
 
-### Binary protocol
-
 ### Configuration
 
 ### CLI
 
-### Metrics
-
-<!--
-For each metric provide:
-* Full name
-* Description
-* Attributes (labels)
-* Unit
--->
-
-
-# Monitoring
-
-<!-- 
-Describe how the changes you make in this proposal should be monitored. 
-Don't describe the detailed metrics - they should be at "Public-facing Changes" / "Metrics" section.
-Describe how the user will use the metrics to monitor the feature: Which alerts they should set up, which thresholds, ...
--->
-
-# Backward & Forward Compatibility
+# Get started
 
-## Upgrade
+## Quick Start
 
 <!--
-Specify the list of instructions, if there are such, needed to perform before/after upgrading to Pulsar version containing this feature.
--->
-
-## Downgrade / Rollback
-
-<!--
-Describe a cookbook detailing the steps required to rollback Pulsar to previous version *without* this feature.
--->
-
-## Pulsar Geo-Replication Upgrade & Downgrade/Rollback Considerations
-
-<!--
-Describe what needs to be considered in Pulsar Geo-Replication in the upgrade and possible downgrade/rollback of this feature.
--->
-
-# Alternatives
-
-<!--
-If there are alternatives that were already considered by the authors or, after the discussion, by the community, and were rejected, please list them here along with the reason why they were rejected.
--->
-
-# General Notes
-
-# Links
-
-<!--
-Updated afterwards
--->
-* Mailing List discussion thread:
-* Mailing List voting thread:
\ No newline at end of file
+Introduce how to use it and teach users how to use it quickly
+-->
\ No newline at end of file
diff --git a/pcip/static/img/pcip-{xxx}-img-{x}.png b/pcip/static/img/pcip-{xxx}/img-{xxx}.png
similarity index 100%
rename from pcip/static/img/pcip-{xxx}-img-{x}.png
rename to pcip/static/img/pcip-{xxx}/img-{xxx}.png