design doc numbering (kptdev#2657)

loudej · Jan 22, 2022 · 3d90e0e · 3d90e0e
1 parent 29c0642
commit 3d90e0e
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/docs/design-docs/00-template.md b/docs/design-docs/00-template.md
@@ -75,6 +75,10 @@ design.
 # Review Process
 
 Design doc creators should raise the pull request similar to [this](https://github.com/GoogleContainerTools/kpt/pull/2576).
+Please name your documents with the design document number.  Pick n+1 from what's currently merged knowing that a slight
+renaming might need to happen if multiple design docs get accepted simultaneously.
+Please keep the name of the design doc in lower case with dashes in between words.
+
 Reviewers are auto-assigned to review the PR. Optionally, doc owner can mention any
 specific reviewers on the PR description. The turn around time for each review cycle
 on the PR from kpt maintainers is 1-2 days. After maintainers add comments to the PR,

diff --git a/...ocs/01-live_Inventory-to-ResourceGroup.md → docs/design-docs/01-live-invenstory-to-rg.md b/...ocs/01-live_Inventory-to-ResourceGroup.md → docs/design-docs/01-live-invenstory-to-rg.md
diff --git a/docs/design-docs/01-oci-support.md → docs/design-docs/02-oci-support.md b/docs/design-docs/01-oci-support.md → docs/design-docs/02-oci-support.md