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.

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

Add documentation for new is operator #67

Merged
merged 6 commits into from
Dec 15, 2023
Merged

Conversation

john-h-kastner-aws
Copy link
Contributor

Adding docs for is operator which will be released in the upcoming Cedar 3.0 release.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Copy link
Contributor

@khieta khieta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall content looks good, although I'll leave the final approval to @AMZ-brandon.

Please also update docs/collections/_other/doc-history.md to reflect that the is operator corresponds to a new language version (2.2.0?).

docs/collections/_policies/syntax-grammar.md Show resolved Hide resolved
@cdisselkoen
Copy link
Contributor

to reflect that the is operator corresponds to a new language version (2.2.0?).

Cedar SDK 3.0 will also have to be language 3.0; although is is not a breaking change for the language, things like RFC 20 are.

@AMZ-brandon
Copy link
Contributor

I'm putting together a preview in my test repo. This branch is behind main - can you update it from the base branch?

@john-h-kastner-aws
Copy link
Contributor Author

updated

@AMZ-brandon
Copy link
Contributor

Thanks for updating! I've pulled the branch - preview here.

I am updating the document history and adding syntax highlighting to is.

What should be the new language version for the doc history? 3.0? And what PR in the Cedar repo matches this update?

@john-h-kastner-aws
Copy link
Contributor Author

What should be the new language version for the doc history? 3.0?

Yes. This will be released with version 3.0 (to be release soon).

And what PR in the Cedar repo matches this update?

is was added in cedar-policy/cedar#396 following to the design in rfc5

@AMZ-brandon
Copy link
Contributor

Let me know if that doc history update looks accurate. Otherwise LGTM & will merge.

@john-h-kastner-aws
Copy link
Contributor Author

We should wait on the merge until the 3.0 release happens so we don't have is referenced in the docs before the new version is on crates.io. That will be a week or two probably.

@AMZ-brandon
Copy link
Contributor

Got it, standing by until I hear of the release.

@AMZ-brandon AMZ-brandon merged commit 928fdc5 into main Dec 15, 2023
@AMZ-brandon AMZ-brandon deleted the feature/jkastner/is_docs branch December 15, 2023 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants