Skip to content

Update documentation mustache templates for proper linting. #2458

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Mar 25, 2019
Merged

Update documentation mustache templates for proper linting. #2458

merged 13 commits into from
Mar 25, 2019

Conversation

theWhiteWulfy
Copy link
Contributor

@theWhiteWulfy theWhiteWulfy commented Mar 20, 2019 •
edited by wing328
Loading

Description of the PR

This pull request fixes issues with markdown linting and style enforcement.
The following changes were made:

  • Headings, lists and code blocks should be enclosed by blank lines, which was done.
  • Made the first heading a top level heading.
  • There were hard tabs in some code blocks, which was removed.
  • Removed multiple top level headings in same document.
  • fixed list indentation and inconsistent style issue.

Ref: #2441

@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for PHP client
a2135c5 
This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
Issues with generated markdown files as reported by markdownlint for node.js are:

- MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
- MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading
- MD007 ul-indent - Unordered list indentation
- MD009 no-trailing-spaces - Trailing spaces
- MD010 no-hard-tabs - Hard tabs
- MD011 no-reversed-links - Reversed link syntax
- MD025 single-h1 - Multiple top level headings in the same document
- MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines
- MD032 blanks-around-lists - Lists should be surrounded by blank lines
- MD040 fenced-code-language - Fenced code blocks should have a language specified
- MD041 first-line-h1 - First line in file should be a top level heading
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for ruby client
277fd1e 
This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
Issues with generated markdown files as reported by markdownlint for node.js are:

- MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
- MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading
- MD007 ul-indent - Unordered list indentation
- MD009 no-trailing-spaces - Trailing spaces
- MD010 no-hard-tabs - Hard tabs
- MD011 no-reversed-links - Reversed link syntax
- MD025 single-h1 - Multiple top level headings in the same document
- MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines
- MD032 blanks-around-lists - Lists should be surrounded by blank lines
- MD040 fenced-code-language - Fenced code blocks should have a language specified
- MD041 first-line-h1 - First line in file should be a top level heading
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for javascrip…
5e7d044 
…t client

This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
Issues with generated markdown files as reported by markdownlint for node.js are:

- MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
- MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading
- MD007 ul-indent - Unordered list indentation
- MD009 no-trailing-spaces - Trailing spaces
- MD010 no-hard-tabs - Hard tabs
- MD011 no-reversed-links - Reversed link syntax
- MD025 single-h1 - Multiple top level headings in the same document
- MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines
- MD032 blanks-around-lists - Lists should be surrounded by blank lines
- MD040 fenced-code-language - Fenced code blocks should have a language specified
- MD041 first-line-h1 - First line in file should be a top level heading
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for Java client
a986f5a 
This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
Issues with generated markdown files as reported by markdownlint for node.js are:

- MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
- MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading
- MD007 ul-indent - Unordered list indentation
- MD009 no-trailing-spaces - Trailing spaces
- MD010 no-hard-tabs - Hard tabs
- MD011 no-reversed-links - Reversed link syntax
- MD025 single-h1 - Multiple top level headings in the same document
- MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines
- MD032 blanks-around-lists - Lists should be surrounded by blank lines
- MD040 fenced-code-language - Fenced code blocks should have a language specified
- MD041 first-line-h1 - First line in file should be a top level heading
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for GO client
ca9ccda 
This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
Issues with generated markdown files as reported by markdownlint for node.js are:

- MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
- MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading
- MD007 ul-indent - Unordered list indentation
- MD009 no-trailing-spaces - Trailing spaces
- MD010 no-hard-tabs - Hard tabs
- MD011 no-reversed-links - Reversed link syntax
- MD025 single-h1 - Multiple top level headings in the same document
- MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines
- MD032 blanks-around-lists - Lists should be surrounded by blank lines
- MD040 fenced-code-language - Fenced code blocks should have a language specified
- MD041 first-line-h1 - First line in file should be a top level heading
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for Rust client
f58d20e 
This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
Issues with generated markdown files as reported by markdownlint for node.js are:

- MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
- MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading
- MD007 ul-indent - Unordered list indentation
- MD009 no-trailing-spaces - Trailing spaces
- MD010 no-hard-tabs - Hard tabs
- MD011 no-reversed-links - Reversed link syntax
- MD025 single-h1 - Multiple top level headings in the same document
- MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines
- MD032 blanks-around-lists - Lists should be surrounded by blank lines
- MD040 fenced-code-language - Fenced code blocks should have a language specified
- MD041 first-line-h1 - First line in file should be a top level heading
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for C# client
120c68e 
This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
Issues with generated markdown files as reported by markdownlint for node.js are:

- MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
- MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading
- MD007 ul-indent - Unordered list indentation
- MD009 no-trailing-spaces - Trailing spaces
- MD010 no-hard-tabs - Hard tabs
- MD011 no-reversed-links - Reversed link syntax
- MD025 single-h1 - Multiple top level headings in the same document
- MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines
- MD032 blanks-around-lists - Lists should be surrounded by blank lines
- MD040 fenced-code-language - Fenced code blocks should have a language specified
- MD041 first-line-h1 - First line in file should be a top level heading
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for Android c…
a3f3814 
…lient

This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
Issues with generated markdown files as reported by markdownlint for node.js are:

- MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
- MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading
- MD007 ul-indent - Unordered list indentation
- MD009 no-trailing-spaces - Trailing spaces
- MD010 no-hard-tabs - Hard tabs
- MD011 no-reversed-links - Reversed link syntax
- MD025 single-h1 - Multiple top level headings in the same document
- MD031 blanks-around-fences - Fenced code blocks should be surrounded by blank lines
- MD032 blanks-around-lists - Lists should be surrounded by blank lines
- MD040 fenced-code-language - Fenced code blocks should have a language specified
- MD041 first-line-h1 - First line in file should be a top level heading
@theWhiteWulfy theWhiteWulfy mentioned this pull request Mar 20, 2019
Open
@wing328
Copy link
Member

wing328 commented Mar 22, 2019

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

theWhiteWulfy and others added 5 commits March 25, 2019 11:12
@theWhiteWulfy
Update README.mustache
3cbd641
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for Ada client
a8bed43 
This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for Apex client
a94f1ec 
This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
@theWhiteWulfy
[OpenAPITools#2441] Update documentation mustache files for bash
59f24eb 
This commit fixes issues with Markdown/CommonMark parsing by linting and enforcing consistent style.[OpenAPITools#2441]
@theWhiteWulfy
Merge remote-tracking branch 'origin/client_docs' into client_docs
888a489
@theWhiteWulfy
Copy link
Contributor Author

@wing328 Thank you pointing that out. I learnt a bit more about interactive rebase while fixing it, thanks for heads up!

I've fixed the author email, and commits are now linked to my GitHub account.

@wing328 wing328 added this to the 4.0.0 milestone Mar 25, 2019
@wing328
Copy link
Member

wing328 commented Mar 25, 2019

Looks good to me. I'll update the samples after merging this PR into master.

@wing328 wing328 merged commit 3810d12 into OpenAPITools:master Mar 25, 2019
@wing328 wing328 changed the title [#2441] Update documentation mustache templates for proper linting. Update documentation mustache templates for proper linting. Mar 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Enhancement: Feature Feature: Documentation
Projects
None yet
Milestone
4.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@theWhiteWulfy @wing328