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

Adding policy page about phylum regos #187

Closed
wants to merge 5 commits into from
Closed

Conversation

janasheehan
Copy link
Contributor

@janasheehan janasheehan commented Jul 30, 2024

This would be a new page, separate from the page dedicate to policy upload and manipulation

closes #189

@janasheehan janasheehan marked this pull request as ready for review August 1, 2024 20:07
@janasheehan janasheehan requested a review from a team as a code owner August 1, 2024 20:07
docs/knowledge_base/policy_phylum.md Outdated Show resolved Hide resolved
@janasheehan janasheehan requested a review from furi0us333 August 1, 2024 20:22
@furi0us333
Copy link
Contributor

Why are we not just updating this page?

@furi0us333
Copy link
Contributor

Is it better to upload the video to the assets folder and reference it that way. I am actually not sure how this works the way it is done here.

@janasheehan
Copy link
Contributor Author

Why are we not just updating this page?

i am doing that separately - started on it, and then realized that the changes have been more complex - and that not everyone will now be able to upload a new rego.

also, i started updating using the edit mode, and could not figure out how to add another page to the original patch

Copy link
Contributor

@maxrake maxrake left a comment

Choose a reason for hiding this comment

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

Adding a new page in the Policy section of the knowledge base requires it to be added to the site generation configuration. Specifically, the site/sidebars.js file needs to be updated to show this page.

BTW...the screenshot generated in this review was done so by updating the config to look like this:

        {
          type: 'category',
          label: 'Policy',
          link: {
            type: 'doc',
            id: 'knowledge_base/policy',
          },
          items: [
            'knowledge_base/policy_basics',
            'knowledge_base/policy_development',
            'knowledge_base/policy_examples',
            'knowledge_base/policy_apply',
            'knowledge_base/policy_phylum',
          ],
        },

The order of the page in relation to the others should be reviewed but in this case it was just added to the end. Then, the page was reviewed by following along with the site/README.md:

## Change into the `site` directory
cd site

## Install the package/dependencies
npm ci

## Build the page locally
npm run build

## Serve the page locally
npm run serve

Lastly, when adding new pages, ensure the filename is good because it will serve as the slug for the URL and, once published the first time, will be a bit harder to change. Not impossible, just a bit harder. I'm not saying policy_phylum.md is a bad name...just that this is the chance to dial it in.




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.

Comment on lines +5 to +7
To explore these in the web UI:


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.

Comment on lines +10 to +14
4. Click the title on any card to open and read the respective rego




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.

Comment on lines +18 to +21


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.

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).

@@ -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.

@janasheehan janasheehan marked this pull request as draft August 5, 2024 20:03
@janasheehan janasheehan closed this Aug 7, 2024
@maxrake maxrake deleted the janasheehan-patch-1 branch September 9, 2024 16:23
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.

Document addition of new phylum policy regos and how to explore them
4 participants