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

[CI] Textlint: properly check for Java capitalization & more #3497

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Nov 5, 2023

  • Fixes Markdown not rendered in Java > Manual instrumentation setup #3498
  • Contributes to CI/infra improvements - 2023/11 #3458
  • Followup and alternative (better) solution to [CI] Textlint: allow .java #3492
  • Adds a proper patter to terminology to recognize and fix "Java" mis-capitalizations. In particular, it avoids reporting false positives:
    • File names: file.java
    • Repo names: opentelemetry-java
    • IDs: java.util.List, as they might appear, e.g., in markdown link-text
  • Drops allow pattern
  • Drops "Java" word from terminology list
  • Makes fixes to doc pages
  • Switches to interpreting .yml files a markdown. This gives us better checking, with fewer false positives, especially for fields that contain markdown
  • Improves on registry-tags allow pattern

Preview: e.g.,

@chalin chalin added the CI/infra CI & infrastructure label Nov 5, 2023
@chalin chalin requested review from a team November 5, 2023 14:07
@chalin chalin marked this pull request as draft November 5, 2023 14:25
@chalin
Copy link
Contributor Author

chalin commented Nov 5, 2023

(A few more fixes are needed here, for other related issues. I'll submit those after my next meeting. Setting to Draft status for now.)

@chalin chalin marked this pull request as ready for review November 5, 2023 15:03
@chalin chalin force-pushed the chalin-im-textlint-dotjava-ok-2023-11-05 branch from 868c783 to 6e1a98c Compare November 5, 2023 15:08
@cartermp cartermp merged commit 47a33be into open-telemetry:main Nov 5, 2023
14 checks passed
@chalin chalin deleted the chalin-im-textlint-dotjava-ok-2023-11-05 branch November 5, 2023 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Markdown not rendered in Java > Manual instrumentation setup
2 participants