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 docs for limits/requests, affinity, reword PDB #393

Merged
merged 6 commits into from
Apr 15, 2024

Conversation

viccuad
Copy link
Member

@viccuad viccuad commented Apr 11, 2024

Description

Fix kubewarden/kubewarden-controller#703

Test

Additional Information

Tradeoff

Potential improvement

@viccuad viccuad requested a review from a team as a code owner April 11, 2024 12:57
Copy link

netlify bot commented Apr 11, 2024

Deploy Preview for silly-bunny-8cedd0 ready!

Name Link
🔨 Latest commit 61a6518
🔍 Latest deploy log https://app.netlify.com/sites/silly-bunny-8cedd0/deploys/6619315bc6b5db0008d76f3e
😎 Deploy Preview https://deploy-preview-393--silly-bunny-8cedd0.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@viccuad viccuad changed the title Add ocs for limits/requests, affinity, reword PDB Add docs for limits/requests, affinity, reword PDB Apr 11, 2024
Copy link
Contributor

@jhkrug jhkrug left a comment

Choose a reason for hiding this comment

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

Some minor suggestions from the hospital waiting room. I'll have another go from a computer with a decent screen tomorrow.

docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
Co-authored-by: John Krug <[email protected]>
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
Copy link
Contributor

@jhkrug jhkrug left a comment

Choose a reason for hiding this comment

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

A few more small typos.

It's not strictly necessary to have a 'sidebar_position' in the front matter, but I'd recommend it so it doesn't get shifted about if additional content files are added.

Also, a _category.json in the new policy-servers directory is a good idea for the same reason. Its 'label' field fixes a position in the howto level.

Otherwise, LGTM!

docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
docs/howtos/policy-servers/03-production-deployments.md Outdated Show resolved Hide resolved
@jhkrug jhkrug added the area/documentation Improvements or additions to documentation label Apr 12, 2024
viccuad and others added 2 commits April 12, 2024 14:47
Co-authored-by: John Krug <[email protected]>
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
@viccuad
Copy link
Member Author

viccuad commented Apr 12, 2024

Thanks for the review! Added sidebar_position, the folder already had a _category.json.

@viccuad viccuad requested a review from jhkrug April 12, 2024 12:49
]
---

PolicyServers are critical to the cluster. Reliability of them is important as
Copy link
Member

Choose a reason for hiding this comment

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

We should have some guidelines about how to spell certain pieces of our tech stack. Do we have to use PolicyServer or Policy Server?

It would be even better to have some keywords that automatically expand to the right term. For example, &policyServer gets expanded to be PolicyServer at rendering time. I don't know if docusaurus has something for that

CC @jhkrug

Copy link
Contributor

@jhkrug jhkrug Apr 12, 2024

Choose a reason for hiding this comment

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

I think we have agreed on PolicyServer, where talking about the component in general. As per the Kubernetes docs style guide. And yes, I can do something about variables in DS. I had to do it for Longhorn. It would be something like

[[< policy-server-component >]] expands to PolicyServer, etc.

Copy link
Member Author

@viccuad viccuad Apr 15, 2024

Choose a reason for hiding this comment

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

Opened #394 to not forget about it, please feel free to edit it.

Co-authored-by: Flavio Castelli <[email protected]>
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
@viccuad viccuad merged commit 073b044 into kubewarden:main Apr 15, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[affinity/anti-affinity] The project documentation mentions this new attribute
4 participants