Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VIP-3: Rust Server Read Path #604

Merged
merged 4 commits into from
Dec 4, 2023
Merged

VIP-3: Rust Server Read Path #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05e8b65
VIP-3: Rust Server Read Path
FelixGV Aug 23, 2023
f9e9064
Added an auth/auth section, based on the comment thread with Zac.
FelixGV Aug 25, 2023
9e7318b
Added a metrics section based on the comment thread with Jialin.
FelixGV Aug 25, 2023
61f33da
Mentioned duchess in the JNI section, and incorporated Gaojie's sugge…
FelixGV Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/assets/images/vip_3_read_path.drawio.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
212 changes: 212 additions & 0 deletions docs/assets/images/vip_3_read_path.drawio.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
<mxfile host="app.diagrams.net" modified="2023-08-23T13:47:02.064Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Safari/605.1.15" etag="jDuoTWvUTu5oXmrRuByY" version="21.6.9" type="device">
manujose0 marked this conversation as resolved.
Show resolved Hide resolved
<diagram id="Kj9ysof-gST6FQAAnX2l" name="Page-1">
<mxGraphModel dx="1940" dy="1162" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="hOQS2fW1jwO_CcEVQ3Ah-2" value="Java Server" style="swimlane;" parent="1" vertex="1">
<mxGeometry x="40" y="80" width="360" height="360" as="geometry" />
</mxCell>
<mxCell id="hOQS2fW1jwO_CcEVQ3Ah-4" value="RocksJava" style="swimlane;" parent="hOQS2fW1jwO_CcEVQ3Ah-2" vertex="1">
<mxGeometry x="110" y="160" width="140" height="120" as="geometry" />
</mxCell>
<mxCell id="hOQS2fW1jwO_CcEVQ3Ah-5" value="RocksDB" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;" parent="hOQS2fW1jwO_CcEVQ3Ah-4" vertex="1">
<mxGeometry x="40" y="35" width="60" height="70" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-46" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="hOQS2fW1jwO_CcEVQ3Ah-2" source="7kTufvKWLoWiJGKeehVl-3" target="hOQS2fW1jwO_CcEVQ3Ah-4">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="20" y="60" />
<mxPoint x="20" y="220" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-3" value="REST Request Handler" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="hOQS2fW1jwO_CcEVQ3Ah-2">
<mxGeometry x="110" y="40" width="140" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-45" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.25;entryDx=0;entryDy=0;" edge="1" parent="hOQS2fW1jwO_CcEVQ3Ah-2" source="7kTufvKWLoWiJGKeehVl-4" target="hOQS2fW1jwO_CcEVQ3Ah-4">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="40" y="120" />
<mxPoint x="40" y="190" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-4" value="gRPC Request Handler" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="hOQS2fW1jwO_CcEVQ3Ah-2">
<mxGeometry x="110" y="100" width="140" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-12" value="JNI Call" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];rotation=0;" vertex="1" connectable="0" parent="hOQS2fW1jwO_CcEVQ3Ah-2">
<mxGeometry x="70" y="50" as="geometry">
<mxPoint x="-0.9999999999999999" y="1" as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-47" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.75;entryDx=0;entryDy=0;" edge="1" parent="hOQS2fW1jwO_CcEVQ3Ah-2" source="7kTufvKWLoWiJGKeehVl-10" target="hOQS2fW1jwO_CcEVQ3Ah-4">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="40" y="320" />
<mxPoint x="40" y="250" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-10" value="Ingestion" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="hOQS2fW1jwO_CcEVQ3Ah-2">
<mxGeometry x="110" y="300" width="140" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-59" value="JNI Call" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];rotation=0;" vertex="1" connectable="0" parent="hOQS2fW1jwO_CcEVQ3Ah-2">
<mxGeometry x="70" y="110" as="geometry">
<mxPoint x="-0.9999999999999999" y="1" as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-60" value="JNI Call" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];rotation=0;" vertex="1" connectable="0" parent="hOQS2fW1jwO_CcEVQ3Ah-2">
<mxGeometry x="70" y="310" as="geometry">
<mxPoint x="-0.9999999999999999" y="1" as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-14" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="7kTufvKWLoWiJGKeehVl-13" target="7kTufvKWLoWiJGKeehVl-3">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-13" value="Router" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="440" y="120" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-16" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.25;exitDx=0;exitDy=0;entryX=1;entryY=0.75;entryDx=0;entryDy=0;" edge="1" parent="1" source="7kTufvKWLoWiJGKeehVl-15" target="7kTufvKWLoWiJGKeehVl-3">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="420" y="190" />
<mxPoint x="420" y="150" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-17" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="7kTufvKWLoWiJGKeehVl-15" target="7kTufvKWLoWiJGKeehVl-4">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-19" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="7kTufvKWLoWiJGKeehVl-18" target="7kTufvKWLoWiJGKeehVl-13">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-20" value="Java Server" style="swimlane;" vertex="1" parent="1">
<mxGeometry x="40" y="520" width="360" height="360" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-21" value="Rust Server" style="swimlane;align=center;verticalAlign=middle;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-20">
<mxGeometry x="80" y="160" width="260" height="120" as="geometry">
<mxRectangle x="80" y="160" width="110" height="30" as="alternateBounds" />
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-22" value="RocksDB" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-21">
<mxGeometry x="20" y="35" width="60" height="70" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-53" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;" edge="1" parent="7kTufvKWLoWiJGKeehVl-21" source="7kTufvKWLoWiJGKeehVl-41" target="7kTufvKWLoWiJGKeehVl-22">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-41" value="gRPC Request Handler" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-21">
<mxGeometry x="100" y="50" width="140" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-50" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="7kTufvKWLoWiJGKeehVl-20" source="7kTufvKWLoWiJGKeehVl-25" target="7kTufvKWLoWiJGKeehVl-21">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="20" y="60" />
<mxPoint x="20" y="220" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-25" value="REST Request Handler" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-20">
<mxGeometry x="110" y="40" width="140" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-54" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.25;entryDx=0;entryDy=0;" edge="1" parent="7kTufvKWLoWiJGKeehVl-20" source="7kTufvKWLoWiJGKeehVl-27" target="7kTufvKWLoWiJGKeehVl-21">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="40" y="120" />
<mxPoint x="40" y="190" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-27" value="gRPC Request Handler" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-20">
<mxGeometry x="110" y="100" width="140" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-49" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.75;entryDx=0;entryDy=0;" edge="1" parent="7kTufvKWLoWiJGKeehVl-20" source="7kTufvKWLoWiJGKeehVl-30" target="7kTufvKWLoWiJGKeehVl-21">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="40" y="320" />
<mxPoint x="40" y="250" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-30" value="Ingestion" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-20">
<mxGeometry x="110" y="300" width="140" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-56" value="JNI Call" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];rotation=0;" vertex="1" connectable="0" parent="7kTufvKWLoWiJGKeehVl-20">
<mxGeometry x="70" y="50" as="geometry">
<mxPoint x="-0.9999999999999999" y="1" as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-57" value="JNI Call" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];rotation=0;" vertex="1" connectable="0" parent="7kTufvKWLoWiJGKeehVl-20">
<mxGeometry x="70" y="110" as="geometry">
<mxPoint x="-0.9999999999999999" y="1" as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-58" value="JNI Call" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];rotation=0;" vertex="1" connectable="0" parent="7kTufvKWLoWiJGKeehVl-20">
<mxGeometry x="70" y="310" as="geometry">
<mxPoint x="-0.9999999999999999" y="1" as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-32" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="7kTufvKWLoWiJGKeehVl-33" target="7kTufvKWLoWiJGKeehVl-25">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-33" value="Router" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="440" y="560" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-34" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.25;exitDx=0;exitDy=0;entryX=1;entryY=0.75;entryDx=0;entryDy=0;" edge="1" parent="1" source="7kTufvKWLoWiJGKeehVl-36" target="7kTufvKWLoWiJGKeehVl-25">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="420" y="630" />
<mxPoint x="420" y="590" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-35" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="7kTufvKWLoWiJGKeehVl-36" target="7kTufvKWLoWiJGKeehVl-27">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-42" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.75;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="7kTufvKWLoWiJGKeehVl-36" target="7kTufvKWLoWiJGKeehVl-41">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="420" y="650" />
<mxPoint x="420" y="750" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-37" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="7kTufvKWLoWiJGKeehVl-38" target="7kTufvKWLoWiJGKeehVl-33">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-39" value="&lt;h2&gt;Current architecture&lt;/h2&gt;" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" vertex="1" parent="1">
<mxGeometry x="20" y="25" width="200" height="60" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-40" value="&lt;h2&gt;Proposed architecture&lt;/h2&gt;" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" vertex="1" parent="1">
<mxGeometry x="20" y="465" width="210" height="60" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-77" value="" style="group" vertex="1" connectable="0" parent="1">
<mxGeometry x="600" y="520" width="180" height="160" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-36" value="Fast Client" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-77">
<mxGeometry x="20" y="100" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-38" value="Thin Client" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-77">
<mxGeometry x="20" y="40" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-75" value="User App" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-77">
<mxGeometry width="160" height="160" as="geometry">
<mxRectangle width="90" height="30" as="alternateBounds" />
</mxGeometry>
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-78" value="" style="group" vertex="1" connectable="0" parent="1">
<mxGeometry x="600" y="80" width="180" height="160" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-15" value="Fast Client" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-78">
<mxGeometry x="20" y="100" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-18" value="Thin Client" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-78">
<mxGeometry x="20" y="40" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="7kTufvKWLoWiJGKeehVl-76" value="User App" style="swimlane;whiteSpace=wrap;html=1;" vertex="1" parent="7kTufvKWLoWiJGKeehVl-78">
<mxGeometry width="160" height="160" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
33 changes: 33 additions & 0 deletions docs/dev_guide/doc_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,39 @@ Note that for now, the doc supports at most 3 levels of nesting.

For more information, consult [Just the Docs](https://just-the-docs.github.io/just-the-docs/docs/navigation-structure/).

## Pictures and Diagrams

It is encouraged to use diagrams within the documentation, but there are some guidelines to standardize the way it is
done, and to avoid certain anti-patterns.

### Text-based Assets

For text-based assets (which are preferred whenever feasible), we wish to check them into source control. This should
include both the displayable asset (e.g. in SVG format) and the source file from which the displayable asset was
generated (e.g. in XML format). This makes the docs self-contained, and enables contributors to edit the assets over
time.

Diagrams conforming to these guidelines can be placed under the `/docs/assets/images` path of the repo, and then
embedded in the docs with a relative link like this:

```markdown
![](../assets/images/vip_3_read_path.drawio.svg)
```

The [draw.io](https://draw.io) service makes it easy to generate such assets.

### Binary Assets

For binary assets (e.g. PNG, BMP, JPG, etc.), we do NOT wish to check them into source control. Instead, they should be
linked from an external source. This can be done in GitHub itself. Within the Pull Request that proposes the doc change,
the contributor can insert images in the PR's description or comments, and then take the URL GitHub generated for it.
Then the modified files included in the PR can be edited to link to that image, and the PR updated. Externally hosted
images can be embedded with an absolute link like this:

```markdown
![](https://user-images.githubusercontent.com/1248632/195111861-518f81c4-f226-4942-b88a-a34337da79e3.png)
```

## Emojis

Here's a link to all the emojis available in README files: [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md).
Expand Down
4 changes: 2 additions & 2 deletions docs/proposals/VIP_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
layout: default
title: Venice Improvement Plan
title: VIP-`$VIP_Number` `$VIP_Title`
parent: Proposals
permalink: /docs/proposals/VIP_TEMPLATE.md
---

# Venice Improvement Proposal Template
# VIP-`$VIP_Number`: `$VIP_Title`

* **Status**: _"one of ['Under Discussion', 'Accepted', 'Adopted', 'Rejected']"_
* **Author(s)**: _(Names)_
Expand Down
Loading