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

Fix typos in composition functions documentation #560

Merged
merged 1 commit into from
Oct 6, 2023

Conversation

mergenci
Copy link
Member

I corrected two typos in composition functions documentation. Because composition functions documentation doesn't exist in v1.11 and v1.12, there are no changes in those directories.

Signed-off-by: Cem Mergenci <cmergenci@gmail.com>
@netlify
Copy link

netlify bot commented Sep 29, 2023

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit a560ad1
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/651697d65bceab00086695e8
😎 Deploy Preview https://deploy-preview-560--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:
Accessibility:
Best Practices:
SEO:
PWA: -
View the detailed breakdown and full score reports

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

@phisco
Copy link
Collaborator

phisco commented Oct 6, 2023

@mergenci
Copy link
Member Author

mergenci commented Oct 6, 2023

@phisco did you mean Vale prefers “general purpose”, rather than “general-purpose”? Because, in the link you posted, I see a Crossplane.Spelling error for “general-purpose”.

How shall I address the error? Shall I define an exception for “general-purpose” in spelling-exceptions.txt? Or, do nothing, because “general-purpose” is valid usage?

By the way, I see more general problems in the Vale output:

  1. e.g.”, “i.e.”, and “general-purpose” are dictionary words that I can look up in my Mac's dictionary. Why are these not in Vale's, or Crossplane's, dictionary?
  2. Vale, or Crossplane's configuration of Vale, doesn't seem to understand how hyphenation in English works. Vale reports errors for “build-time”, “in-place”, and “bug-fixes”. Even though I wouldn't prefer hyphenation in the latter two, they are certainly not spelling errors.

Is there anything that we can do to address the above issues?

@phisco
Copy link
Collaborator

phisco commented Oct 6, 2023

Ah, I interpreted it the other way around, my bad, yes, it's complaining about the remaining occurrences of general-purpose. That's fine then, no need to go through all the errors, that section of the documentation will probably be reworked pretty intensively for the beta version with 1.14.

@plumbis
Copy link
Collaborator

plumbis commented Oct 6, 2023

Thanks for the update! I'm good with the Vale errors as we haven't gotten this page to pass Vale yet, so we can treat it as an exception for now.

@plumbis plumbis merged commit bb2042b into crossplane:master Oct 6, 2023
6 of 7 checks passed
plumbis pushed a commit to plumbis/crossplane-docs that referenced this pull request Oct 31, 2023
@mergenci mergenci mentioned this pull request Feb 26, 2024
6 tasks
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