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

feat(docs/concepts): add details for all concepts #70

Merged
merged 9 commits into from
Oct 13, 2023
Merged

Conversation

GeorgeMac
Copy link
Member

@GeorgeMac GeorgeMac commented Oct 11, 2023

This adds details to the concepts pages for the following topics:

  • Resource Definitions
  • Controllers
  • Bindings

@vercel
Copy link

vercel bot commented Oct 11, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
cup ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 13, 2023 8:20am

@GeorgeMac GeorgeMac marked this pull request as ready for review October 11, 2023 15:44
@GeorgeMac GeorgeMac requested a review from a team as a code owner October 11, 2023 15:44
@GeorgeMac GeorgeMac changed the title feat(docs/concepts): add details around resource definitions feat(docs/concepts): add details for all concepts Oct 11, 2023
Copy link
Contributor

@yquansah yquansah left a comment

Choose a reason for hiding this comment

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

Looks amazing overall.

docs/site/pages/concepts/controllers.mdx Outdated Show resolved Hide resolved
docs/site/pages/concepts/controllers.mdx Outdated Show resolved Hide resolved

TBD:

- What makes sense to return from the binary?
Copy link
Contributor

Choose a reason for hiding this comment

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

We have a sample wasm controller written for Flipt resource definitions right? I wonder if it makes sense to link to that somewhere here for reference.

Copy link
Member Author

Choose a reason for hiding this comment

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

That sounds like a great idea.

Copy link
Member Author

Choose a reason for hiding this comment

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

I added a callout near the top of the WASM section. Let me know what you think 👍

Copy link
Contributor

@markphelps markphelps left a comment

Choose a reason for hiding this comment

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

couple minor wording changes, otherwise lgtm

docs/site/pages/concepts/controllers.mdx Outdated Show resolved Hide resolved
docs/site/pages/concepts/definitions.mdx Outdated Show resolved Hide resolved
@GeorgeMac GeorgeMac enabled auto-merge October 13, 2023 08:20
@GeorgeMac GeorgeMac merged commit 2c9bcb0 into main Oct 13, 2023
3 checks passed
@GeorgeMac GeorgeMac deleted the gm/docs-concepts branch October 13, 2023 08:24
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.

3 participants