Skip to content

Commit

Permalink
Publish an RFC book (#91)
Browse files Browse the repository at this point in the history
Signed-off-by: Adrian Palacios <[email protected]>
  • Loading branch information
adpaco-aws authored Dec 4, 2024
1 parent 919c774 commit 44de989
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 (<https://github.com/cedar-policy/rfcs/blob/main/0000-template.md>). 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 (<https://github.com/cedar-policy/rfcs/blob/main/text/0000-template.md>). 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.

Expand Down
File renamed without changes.
9 changes: 9 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[book]
authors = ["Cedar Contributors"]
language = "en"
multilingual = false
src = "text"
title = "Cedar RFC Book"

[output.html]
no-section-label = true
File renamed without changes.
24 changes: 24 additions & 0 deletions text/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[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)
- [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)
11 changes: 11 additions & 0 deletions text/intro.md
Original file line number Diff line number Diff line change
@@ -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

<!-- TBD -->

0 comments on commit 44de989

Please sign in to comment.