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.

Sign up for GitHub

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

Adding policy page about phylum regos #187

Closed
wants to merge 5 commits into from
Closed

Adding policy page about phylum regos #187

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
976fba3
Create policy_phylum.md
janasheehan Jul 30, 2024
60ba0a5
Update policy_phylum.md
janasheehan Aug 1, 2024
22a39fd
Update docs/knowledge_base/policy_phylum.md
janasheehan Aug 1, 2024
3c17c3b
Update policy_phylum.md
janasheehan Aug 1, 2024
fe56eca
Update docs/knowledge_base/policy_phylum.md
janasheehan Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/knowledge_base/policy_phylum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Phylum Policies

Out of the box, Phylum provides roughly two dozen pre-defined policies that allow users to specify what their organization's acceptable use policies are for open source packages
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Out of the box, Phylum provides roughly two dozen pre-defined policies that allow users to specify what their organization's acceptable use policies are for open source packages
Out of the box, Phylum provides roughly two dozen pre-defined policies that allow users to specify what their organization's acceptable use policies are for open source packages.

Add period.


To explore these in the web UI:


Comment on lines +5 to +7
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To explore these in the web UI:
To explore these in the web UI:

Remove extra blank line.

1. Open the `Policy` tab of an existing group page (create new group if you do not have any)
2. Select `Phylum` and `Available` to see the list of all policies authored by Phylum
4. Click the title on any card to open and read the respective rego




Comment on lines +10 to +14
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
4. Click the title on any card to open and read the respective rego
3. Click the title on any card to open and read the respective rego

Skipped from 2 to 4.
Remode extra blank lines after the list.


https://github.com/user-attachments/assets/67a17c27-c389-4f89-aafc-d8fda16a3542
Copy link
Contributor

Choose a reason for hiding this comment

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

Including a video like this as a bare link will not render in the Docusaurus-generated static page. It will look like a link:

image

Instead of attempting to get this to show as a video, the recommended approach is to use screenshots, with highlighting where helpful, stored in the assets directory, and referenced relatively. See other pages for an example of this (e.g., docs/knowledge_base/policy_apply.md). Each of the items in the ordered list could be a separate screenshot.




A curated subset of the Phylum policies will be automatically active on newly created groups and personal projects to ensure Phylum surfaces potential risks in your projects.

Comment on lines +18 to +21
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
A curated subset of the Phylum policies will be automatically active on newly created groups and personal projects to ensure Phylum surfaces potential risks in your projects.
A curated subset of the Phylum policies will be automatically active on newly created groups and personal projects to ensure Phylum surfaces potential risks in your projects.

Remove extra blank lines before and after (there should only be one blank line at the end of the page).