From 9a32c4b0caafc6aa47834d92a7edbcb7b87d7507 Mon Sep 17 00:00:00 2001 From: Adrian Palacios Date: Tue, 3 Dec 2024 16:00:29 -0500 Subject: [PATCH 1/5] Add/move files to generate a book Signed-off-by: Adrian Palacios --- README.md | 2 +- book.toml | 9 ++++++++ 0000-template.md => text/0000-template.md | 0 text/SUMMARY.md | 25 +++++++++++++++++++++++ text/intro.md | 11 ++++++++++ 5 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 book.toml rename 0000-template.md => text/0000-template.md (100%) create mode 100644 text/SUMMARY.md create mode 100644 text/intro.md diff --git a/README.md b/README.md index 8ce6e939..3bcfec13 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ It's often helpful to get feedback on your concept before diving into the design In short, to get a major feature added to Cedar, you must first get the RFC merged into the RFC repo as a markdown file. At that point the RFC is 'active' and may be implemented with the goal of eventual inclusion into Cedar. -* Work on your proposal in a markdown file based on the template (). Put care into the details: RFCs that do not present convincing motivation, demonstrate understanding of the impact of the design, or are disingenuous about the drawbacks or alternatives tend to be poorly-received. Copy your markdown file into `text/0000-my-feature.md`, where my-feature is descriptive. +* Work on your proposal in a markdown file based on the template (). Put care into the details: RFCs that do not present convincing motivation, demonstrate understanding of the impact of the design, or are disingenuous about the drawbacks or alternatives tend to be poorly-received. Copy your markdown file into `text/0000-my-feature.md`, where my-feature is descriptive. * Fork this repository and create a PR with your markdown file. Once you have a PR, fill in the number in your filename with the PR number (e.g., `0003-my-feature.md` for PR #3). We will use this PR to provide feedback and to come to a consensus on whether the RFC should be accepted. Revisions to the RFC based on feedback should be done in the same PR. * Your RFC is now Pending. See "The RFC life-cycle" above for more on the next steps. diff --git a/book.toml b/book.toml new file mode 100644 index 00000000..7356f27b --- /dev/null +++ b/book.toml @@ -0,0 +1,9 @@ +[book] +authors = ["Cedar Contributors"] +language = "en" +multilingual = false +src = "text" +title = "Cedar RFC Book" + +[output.html] +no-section-label = true \ No newline at end of file diff --git a/0000-template.md b/text/0000-template.md similarity index 100% rename from 0000-template.md rename to text/0000-template.md diff --git a/text/SUMMARY.md b/text/SUMMARY.md new file mode 100644 index 00000000..4be3346c --- /dev/null +++ b/text/SUMMARY.md @@ -0,0 +1,25 @@ +[Introduction](./intro.md) +[RFC Template](./0000-template.md) + +# Cedar RFCs + +- [0005-is-operator](0005-is-operator.md) +- [0009-disallow-whitespace-in-entityuid](0009-disallow-whitespace-in-entityuid.md) +- [0019-stricter-validation](0019-stricter-validation.md) +- [0020-unique-record-keys](0020-unique-record-keys.md) +- [0021-any-and-all-operators](0021-any-and-all-operators.md) +- [0024-schema-syntax](0024-schema-syntax.md) +- [0032-port-formalization-to-lean](0032-port-formalization-to-lean.md) +- [0034-precomputed-entity-attributes](0034-precomputed-entity-attributes.md) +- [0048-schema-annotations](0048-schema-annotations.md) +- [0052-reserved-namespaces](0052-reserved-namespaces.md) +- [0053-enum-entities](0053-enum-entities.md) +- [0055-remove-unspecified](0055-remove-unspecified.md) +- [0057-general-multiplication](0057-general-multiplication.md) +- [0062-extended-has](0062-extended-has.md) +- [0068-entity-tags](0068-entity-tags.md) +- [0070-disallow-empty-namespace-shadowing](0070-disallow-empty-namespace-shadowing.md) +- [0071-trailing-commas](0071-trailing-commas.md) +- [0076-entity-slice-validation](0076-entity-slice-validation.md) +- [0080-datetime-extension](0080-datetime-extension.md) +- [0082-entity-tags](0082-entity-tags.md) diff --git a/text/intro.md b/text/intro.md new file mode 100644 index 00000000..8214b240 --- /dev/null +++ b/text/intro.md @@ -0,0 +1,11 @@ +# Introduction + +[Cedar](https://www.cedarpolicy.com/en) +is an open source policy language and evaluation engine. +This book collects all the accepted RFCs +([Request for Comments](https://en.wikipedia.org/wiki/Request_for_Comments)) for Cedar, +providing a central repository for easier access and reference. + +# RFC Status + + From 4915d17cf593a7429aa8b2513dfd7067568e72f7 Mon Sep 17 00:00:00 2001 From: Adrian Palacios Date: Tue, 3 Dec 2024 16:14:19 -0500 Subject: [PATCH 2/5] Add deploy workflow Signed-off-by: Adrian Palacios --- .github/workflows/deploy.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 00000000..5b4751d4 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,25 @@ +name: Deploy Book +on: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Setup mdBook + uses: peaceiris/actions-mdbook@v2 + with: + mdbook-version: 'latest' + + - run: mdbook build + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.ref == 'refs/heads/main' }} + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./book From 90b7e4c71080060f9fb756b322d4597bd2ce769b Mon Sep 17 00:00:00 2001 From: Adrian Palacios Date: Tue, 3 Dec 2024 16:26:27 -0500 Subject: [PATCH 3/5] Add newspace Signed-off-by: Adrian Palacios --- book.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book.toml b/book.toml index 7356f27b..8a66b788 100644 --- a/book.toml +++ b/book.toml @@ -6,4 +6,4 @@ src = "text" title = "Cedar RFC Book" [output.html] -no-section-label = true \ No newline at end of file +no-section-label = true From 5e273b1f7ba128f5d5151d7678bd497acb0cfc7f Mon Sep 17 00:00:00 2001 From: Adrian Palacios Date: Tue, 3 Dec 2024 17:01:17 -0500 Subject: [PATCH 4/5] Drop RFC 68 from book Signed-off-by: Adrian Palacios --- text/SUMMARY.md | 1 - 1 file changed, 1 deletion(-) diff --git a/text/SUMMARY.md b/text/SUMMARY.md index 4be3346c..d0460712 100644 --- a/text/SUMMARY.md +++ b/text/SUMMARY.md @@ -17,7 +17,6 @@ - [0055-remove-unspecified](0055-remove-unspecified.md) - [0057-general-multiplication](0057-general-multiplication.md) - [0062-extended-has](0062-extended-has.md) -- [0068-entity-tags](0068-entity-tags.md) - [0070-disallow-empty-namespace-shadowing](0070-disallow-empty-namespace-shadowing.md) - [0071-trailing-commas](0071-trailing-commas.md) - [0076-entity-slice-validation](0076-entity-slice-validation.md) From 6d191283dc13bd24c87f7028c297625286ca2b28 Mon Sep 17 00:00:00 2001 From: Adrian Palacios Date: Wed, 4 Dec 2024 14:52:27 -0500 Subject: [PATCH 5/5] Move RFC 68 to archive Signed-off-by: Adrian Palacios --- {text => archive/rfc}/0068-entity-tags.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {text => archive/rfc}/0068-entity-tags.md (100%) diff --git a/text/0068-entity-tags.md b/archive/rfc/0068-entity-tags.md similarity index 100% rename from text/0068-entity-tags.md rename to archive/rfc/0068-entity-tags.md