influxdata / influxdata/docs-v2
Cleanup Telegraf release notes and fix linting rules
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
Lint report errors for Telegraf release notes page. Fix the problems or fix the linter--many of these are false positives.
```
content/telegraf/v1/release-notes.md
30:93 error Use 'Arrow' instead of Vale.Terms
'arrow'.
147:93 error Use 'Arrow' instead of Vale.Terms
'arrow'.
300:99 error 's.K' should have one space. Google.Spacing
403:93 error Use 'Arrow' instead of Vale.Terms
'arrow'.
450:93 error Use 'Arrow' instead of Vale.Terms
'arrow'.
687:40 error Commas and periods go inside Google.Quotes
quotation marks.
687:48 error Commas and periods go inside Google.Quotes
quotation marks.
689:40 error Don't use exclamation points Google.Exclamation
in text.
723:84 error Use 'Arrow' instead of Vale.Terms
'arrow'.
724:110 error 'to' is repeated! Vale.Repetition
731:68 error Don't use exclamation points Google.Exclamation
in text.
993:93 error Use 'Unix' instead of 'unix'. Vale.Terms
1062:97 error Use 'Unix' instead of 'unix'. Vale.Terms
1347:64 error Use 'that is' instead of Google.Latin
'i.e.'.
1416:3 error Don't use periods with Google.Periods
acronyms or initialisms such
as 'S.M.A.R.T.'.
1519:3 error Don't use periods with Google.Periods
acronyms or initialisms such
as 'S.M.A.R.T.'.
1570:3 error Use 'Execd' instead of Vale.Terms
'execd'.
1635:40 error 'locally-defined' doesn't need Google.LyHyphens
a hyphen.
1669:49 error 's.F' should have one space. Google.Spacing
1740:57 error Use 'Unix' instead of 'unix'. Vale.Terms
1991:64 error Commas and periods go inside Google.Quotes
quotation marks.
1991:71 error Commas and periods go inside Google.Quotes
quotation marks.
1993:54 error Commas and periods go inside Google.Quotes
quotation marks.
1993:59 error Commas and periods go inside Google.Quotes
quotation marks.
2064:3 error Use 'Execd' instead of Vale.Terms
'execd'.
2248:58 error Use 'that is' instead of Google.Latin
'i.e.'.
2258:55 error Don't use exclamation points Google.Exclamation
in text.
2421:63 error Use 'Unix' instead of 'unix'. Vale.Terms
2444:3 error Use 'Execd' instead of Vale.Terms
'execd'.
2526:35 error Use 'for example' instead of Google.Latin
'e.g.'.
2578:41 error Use 'for example' instead of Google.Latin
'e.g.'.
2768:3 error Don't use periods with Google.Periods
acronyms or initialisms such
as 'S.M.A.R.T.'.
2819:56 error Use 'July 31, 2016' format, InfluxDataDocs.DateFormat
not '1.61.1836'.
2841:56 error Use 'July 31, 2016' format, InfluxDataDocs.DateFormat
not '1.61.1818'.
2841:69 error Use 'July 31, 2016' format, InfluxDataDocs.DateFormat
not '1.61.1836'.
3053:3 error Use 'Execd' instead of Vale.Terms
'ExecD'.
3078:56 error Use 'July 31, 2016' format, InfluxDataDocs.DateFormat
not '1.61.1695'.
3078:69 error Use 'July 31, 2016' format, InfluxDataDocs.DateFormat
not '1.61.1727'.
3498:8 error Use 'v2' instead of 'V2'. Vale.Terms
3563:12 error Use 'v2' instead of 'V2'. Vale.Terms
3586:8 error Use 'v2' instead of 'V2'. Vale.Terms
3661:56 error Use 'July 31, 2016' format, InfluxDataDocs.DateFormat
not '1.61.1004'.
3661:69 error Use 'July 31, 2016' format, InfluxDataDocs.DateFormat
not '1.61.1483'.
3807:12 error 'when' is repeated! Vale.Repetition
3848:12 error Use 'v2' instead of 'V2'. Vale.Terms
3961:8 error Use 'v2' instead of 'V2'. Vale.Terms
4011:17 error Use 'v2' instead of 'V2'. Vale.Terms
4067:40 error Use 'Unix' instead of 'unix'. Vale.Terms
4216:9 error Use 'v2' instead of 'V2'. Vale.Terms
4249:131 error 'to' is repeated! Vale.Repetition
4665:65 error Use 'URL' instead of 'url'. Vale.Terms
4788:5 error Don't use periods with Google.Periods
acronyms or initialisms such
as 'S.M.A.R.T.'.
4801:17 error Use 'Unix' instead of 'unix'. Vale.Terms
4936:46 error Use 'Unix' instead of 'unix'. Vale.Terms
5076:19 error Use 'Unix' instead of 'unix'. Vale.Terms
5093:32 error Use 'URL' instead of 'url'. Vale.Terms
5121:7 error Use 'Unix' instead of 'unix'. Vale.Terms
5161:47 error Don't use periods with Google.Periods
acronyms or initialisms such
as 'S.M.A.R.T.'.
5388:50 error Don't put a space before or Google.EmDash
after a dash.
5462:39 error Use 'Unix' instead of 'UNIX'. Vale.Terms
5539:16 error Use 'Unix' instead of 'unix'. Vale.Terms
5695:32 error Use 'Unix' instead of 'unix'. Vale.Terms
5750:51 error Use 'CSV' instead of 'csv'. Vale.Terms
5814:40 error 'd. T' should have one space. Google.Spacing
5815:49 error 'y. F' should have one space. Google.Spacing
5820:68 error 'd. T' should have one space. Google.Spacing
5876:42 error Use 'Unix' instead of 'UNIX'. Vale.Terms
5976:4 error Use 'CSV' instead of 'csv'. Vale.Terms
6011:7 error 'filecount' is repeated! Vale.Repetition
6035:7 error Use 'CSV' instead of 'csv'. Vale.Terms
6124:66 error 't. T' should have one space. Google.Spacing
6124:70 error Don't start a sentence with write-good.ThereIs
'There is'.
6249:8 error 's. T' should have one space. Google.Spacing
6333:49 error Use 'Unix' instead of 'UNIX'. Vale.Terms
6419:22 error 'e. T' should have one space. Google.Spacing
6423:62 error 'e. U' should have one space. Google.Spacing
6545:38 error 'g. T' should have one space. Google.Spacing
6611:31 error Commas and periods go inside Google.Quotes
quotation marks.
6652:35 error Commas and periods go inside Google.Quotes
quotation marks.
6730:288 error Use 'Unix' instead of 'unix'. Vale.Terms
6730:296 error Use 'Unix' instead of 'unix'. Vale.Terms
6775:129 error 'newly-created' doesn't need a Google.LyHyphens
hyphen.
6797:16 error 'i.P' should have one space. Google.Spacing
6832:70 error Commas and periods go inside Google.Quotes
quotation marks.
6855:18 error 'c.S' should have one space. Google.Spacing
6884:81 error Don't use plurals in Google.OptionalPlurals
parentheses such as in
'issue(s)'.
6923:41 error Don't start a sentence with write-good.ThereIs
'There is'.
6965:24 error 'v.P' should have one space. Google.Spacing
7005:1 error Don't start a sentence with write-good.ThereIs
'There is'.
7087:24 error Use 'URL' instead of 'url'. Vale.Terms
7089:41 error Use 'URL' instead of 'url'. Vale.Terms
7123:13 error Use 'URL' instead of 'url'. Vale.Terms
✖ 92 errors, 0 warnings and 0 suggestions in 1 file.
```
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with content/telegraf/v1/release-notes.md and review the listed lines against the reported Vale and Google lint rules. Determine which findings are valid wording or formatting fixes and which are false positives that require rule changes, then rerun the documentation lint until the 92 reported errors are resolved or intentionally addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100