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

docs: fix markdown linter issues #1004

Merged
merged 5 commits into from
Feb 21, 2024

Conversation

akkshitgupta
Copy link
Contributor


title: "style: format the spec/asyncapi.md file with proper linting"


Related issue(s): #1001

Description
spec/asyncapi.md file has a number of markdown lint errors which is holding back the merge of issue: #1001 as the linter is failing. This pull request fix the corresponding lint errors.

Add the ✏️ Editorial label.

Copy link

sonarcloud bot commented Dec 14, 2023

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@akkshitgupta
Copy link
Contributor Author

hey @smoya can you check through the lint changes as mentioned in comment here

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it looks good

changes are mainly whitespaces and added space between headings and paragraphs

@derberg derberg changed the title style: format the spec/asyncapi.md file docs: fix markdown linter issues Feb 13, 2024

Part of this content has been taken from the great work done by the folks at the [OpenAPI Initiative](https://openapis.org).

#### Version 3.0.0
### Version 3.0.0
Copy link
Member

@smoya smoya Feb 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember having some issues with the right panel navigation in the rendered website whenever we changed that. Not saying this will break anything but not sure either if this will happen 🤔 Just double checking with @derberg and @akshatnema just in case you know if this will be rendered properly.

Otherwise, LGTM!

For the reference, I mean this panel
Google Chrome_EVccZsxA

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't recall any issues really, as h3 all should be good I think

Copy link

sonarcloud bot commented Feb 21, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@smoya
Copy link
Member

smoya commented Feb 21, 2024

/rtm

@smoya smoya added ✏️ Editorial PR is non-normative or does not influence implementation ready-to-merge and removed ready-to-merge labels Feb 21, 2024
@asyncapi-bot asyncapi-bot merged commit f66ed79 into asyncapi:master Feb 21, 2024
11 checks passed
artellador pushed a commit to artellador/asyncapi-spec that referenced this pull request Feb 24, 2024
Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com>%0ACo-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>

(cherry picked from commit f66ed79)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✏️ Editorial PR is non-normative or does not influence implementation ready-to-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants