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

Update composition-functions.md #774

Merged
merged 1 commit into from
May 29, 2024
Merged

Conversation

joebowbeer
Copy link
Contributor

@joebowbeer joebowbeer commented May 15, 2024

Fix several nits in the composition functions doc.

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

Copy link

netlify bot commented May 15, 2024

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit cc36755
🔍 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
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
Copy link
Collaborator

plumbis commented May 15, 2024

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

@joebowbeer
Copy link
Contributor Author

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

@joebowbeer
Copy link
Contributor Author

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

@jbw976
Copy link
Member

jbw976 commented May 23, 2024

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?

Signed-off-by: Joe Bowbeer <joe.bowbeer@gmail.com>
@joebowbeer
Copy link
Contributor Author

joebowbeer commented May 26, 2024

@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 jbw976 merged commit cb3de7f into crossplane:master May 29, 2024
7 checks passed
@jbw976
Copy link
Member

jbw976 commented May 29, 2024

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

@joebowbeer joebowbeer deleted the patch-2 branch May 29, 2024 01:22
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