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: surface the diff doc #9

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: surface the diff doc #9

wants to merge 1 commit into from

Conversation

naugtur
Copy link
Member

@naugtur naugtur commented Sep 18, 2024

Show the diff doc in sidebar and link up from policy doc

@@ -9,15 +9,15 @@ This guide will help you understand what a LavaMoat Policy is and how to use it.

## What's a Policy?

A Policy is an object that describes which _resources_ any given dependency can access. These "resources" include globals, builtins (e.g., `node:fs`), native modules, and other packages. _All direct and transitive dependencies_ in your application's dependency tree are subject to a Policy.
A Policy is an object that describes which _powers_ any given dependency can access. These "powers" include globals, builtins (e.g., `node:fs`), native modules, and other packages. _All direct and transitive dependencies_ in your application's dependency tree are subject to a Policy.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
A Policy is an object that describes which _powers_ any given dependency can access. These "powers" include globals, builtins (e.g., `node:fs`), native modules, and other packages. _All direct and transitive dependencies_ in your application's dependency tree are subject to a Policy.
A Policy is an object that describes which _capabilities_ any given dependency can access. These capabilities include globals, builtins (e.g., `node:fs`), native modules, and other packages. _All direct and transitive dependencies_ in your application's dependency tree are subject to a Policy.

Why "powers"? Is this an existing concept from elsewhere or minted here?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's a concept from Object Capability programming and I also defined iit in the glossary now.
You can't frequent Endo meetings to become more familiar with the terminology, but they're recorded and you can catch up on them on Agoric's youtube.
Here's an archive https://www.youtube.com/watch?v=tM5NyB7xxYM&list=PLzDw4TTug5O0eUj81Vnkp-mFuI4O0rBnc
Not sure if the latest ones were being added to the playlist. Check main channel.

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'll shave the yak on the difference between capabilities and powers internally

Copy link
Contributor

@boneskull boneskull left a comment

Choose a reason for hiding this comment

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

IMO calling this "policy review" doesn't really do it justice vs its importance. Nobody will know when or why to click on the link. It should probably be more clickbaity or otherwise draw attention to itself. You could add a "tag" to it, e.g., Important! or something.

Also needs cross-referencing in the getting started docs.

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