crossplane / docs

Repo for Crossplane documentation.
https://docs.crossplane.io
Other
47 stars 105 forks source link

Update composition-functions.md #774

Closed joebowbeer closed 1 month ago

joebowbeer commented 2 months ago

Fix several nits in the composition functions doc.

Also fixed a couple typos in the vale config file comments.

netlify[bot] commented 2 months ago

Deploy Preview for crossplane ready!

Name Link
Latest commit cc36755c847235887523a70dc034d73c116540e5
Latest deploy log https://app.netlify.com/sites/crossplane/deploys/66528cd05e45c300083cf8f5
Deploy Preview https://deploy-preview-774--crossplane.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

Lighthouse
1 paths audited
Performance: 89 (🟒 up 4 from production)
Accessibility: 90 (πŸ”΄ down 2 from production)
Best Practices: 83 (no change from production)
SEO: 93 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

plumbis commented 2 months ago

Let's wait for the 1.16 docs to publish in #773 before merging

joebowbeer commented 2 months ago

@plumbis PTAL - I improved wording to address a passive voice lint check

joebowbeer commented 2 months ago

Please overrule the lint check. It is not helping in this case.

jbw976 commented 1 month ago

Please overrule the lint check. It is not helping in this case.

This can be done within your changes as described in the contributing guide: https://docs.crossplane.io/contribute/vale/#ignore-vale-rules

want to give that a try with another commit @joebowbeer?

joebowbeer commented 1 month ago

@jbw976 PTAL - passive voice lint rule selectively disabled

By the way, as an author and technical reviewer, I could not function without passive voice.

I think Robert Delwood makes some good points in this article:

There is No You in API: A Case for Passive Voice in API Documentation

Use active voice where it makes sense. But understand that passive voice isn’t a grammatical error; it’s a matter of style. It’s your friend when the thing receiving an action is the important part of the sentence β€” especially in scientific and legal contexts β€” when the performer of an action is unknown or in cases where the performer distracts or is irrelevant.

jbw976 commented 1 month ago

Thanks @joebowbeer for both the contribution and the good article about passive voice! that was an interesting read. it's good to have the option to use passive voice when it makes more sense and it looks like there are a good number of those exceptions in this docs repo already. the more writer/author inclined maintainers on this repo can consider if more relaxed rules would be better for a new default, but I have a feeling that keeping the default as is and allowing exceptions when needed is a reasonable compromise :)