Skip to content

Add spell checking via CI #1866

Open
Open
@rockdaboot

Description

@rockdaboot

Even the tool codespell finds a lot of spelling errors in the documentation.
Does it make sense to add a detection via CI?
Maybe there are better tools for documentation, codespell is mostly for code (you may have guessed it ;))!?

Findings (curated list, but still needs manual verification):

./docs/en/integrations/quick-start.asciidoc:74: pacakge ==> package
./docs/en/integrations/build-integration.asciidoc:317: aformentioned ==> aforementioned
./docs/en/integrations/build-integration.asciidoc:347: acount ==> account
./docs/en/integrations/integrations-guidelines.asciidoc:63: quering ==> querying
./docs/en/integrations/integrations-guidelines.asciidoc:80: chosing ==> choosing
./docs/en/integrations/integrations-guidelines.asciidoc:288: vizualizations ==> visualizations
./docs/en/integrations/developer-workflow-import-beat.asciidoc:179: mutliple ==> multiple
./docs/en/observability/profiling-troubleshooting.asciidoc:106: Profling ==> Profiling
./docs/en/observability/ci-cd-observability.asciidoc:443: fileds ==> fields
./docs/en/observability/synthetics-command-reference.asciidoc:85: documention ==> documentation
./docs/en/observability/synthetics-role-setup.asciidoc:47: pipline ==> pipeline
./docs/en/observability/apm/exploring-es-data.asciidoc:16: manged ==> managed
./docs/en/observability/apm/getting-started-apm-server.asciidoc:123: prefered ==> preferred
./docs/en/observability/apm/tab-widgets/distributed-trace-send.asciidoc:55: inout ==> input, in out
./docs/en/observability/apm/configure/outputs/logstash.asciidoc:161: steams ==> streams
./docs/en/observability/apm/configure/outputs/kafka.asciidoc:280: keep-alives ==> keep-alive
./docs/en/observability/apm-ui/machine-learning.asciidoc:71: enviroment ==> environment
./docs/en/observability/apm-ui/apm-spaces.asciidoc:8: steams ==> streams
./docs/en/observability/cloud-monitoring/aws/monitor-aws-cloudwatch-firehose.asciidoc:198: Vizualize ==> Visualize
./docs/en/observability/monitor-infra/host-details-partial.asciidoc:168: desribed ==> described
./docs/en/serverless/alerting/create-elasticsearch-query-alert-rule.mdx:65: theshold ==> threshold
./docs/en/serverless/projects/billing.mdx:10: severless ==> serverless
./docs/en/serverless/transclusion/apm/guide/spec/v2/transaction.mdx:161: referers ==> referrer, referrers
./docs/en/serverless/transclusion/apm/guide/spec/v2/transaction.mdx:191: contais ==> contains
./docs/en/serverless/transclusion/apm/guide/spec/v2/error.mdx:162: referers ==> referrer, referrers
./docs/en/serverless/transclusion/apm/guide/spec/v2/error.mdx:192: contais ==> contains
./docs/en/serverless/transclusion/apm/guide/spec/v2/error.mdx:976: differnt ==> different
./docs/en/serverless/transclusion/apm/guide/spec/v2/error.mdx:976: languange ==> language
./docs/en/serverless/synthetics/synthetics-command-reference.mdx:105: documention ==> documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:DocsEngIssues owned by the Docs Engineering Team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions