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

fix(docs): indentation formatting on several admonitions #701

Merged
merged 2 commits into from
Apr 4, 2024

Conversation

vidofnir
Copy link
Contributor

@vidofnir vidofnir commented Apr 3, 2024

There was missing indentation on several admonitions which resulted in a admonition box (e.g. 'Note') and the text that should be inside the box was just appearing below the box as regular text.

Fix:
After a '!!! note' etc. the admonition content on the next line need to be aligned with the 'note'.

@vidofnir vidofnir requested a review from a team April 3, 2024 07:21
@byashimov
Copy link
Contributor

Hey @vidofnir! Indeed, the admonitions formatting is invalid.
Could you amend the commit title to "fix(docs): indentation formatting on several admonitions" please? We use conventionalcommits and the linter doesn't let me merge your PR. Thank you for your contribution!

@byashimov byashimov added the documentation Improvements or additions to documentation label Apr 3, 2024
@vidofnir
Copy link
Contributor Author

vidofnir commented Apr 3, 2024

I did the following on my side now:

git commit --amend -m "fix(docs): indentation formatting on several admonitions"
git push origin main --force

@Serpentiel Serpentiel self-assigned this Apr 4, 2024
@Serpentiel
Copy link
Contributor

Serpentiel commented Apr 4, 2024

Hey, @vidofnir! 👋

Thank you for your contribution!

I'll run the CI now, let's see if there's anything to be adjusted :)

Copy link
Contributor

@Serpentiel Serpentiel left a comment

Choose a reason for hiding this comment

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

lgtm

@Serpentiel Serpentiel enabled auto-merge (squash) April 4, 2024 10:46
@Serpentiel Serpentiel disabled auto-merge April 4, 2024 10:46
@Serpentiel Serpentiel changed the title Fixed indentation formatting on several admonitions fix(docs): indentation formatting on several admonitions Apr 4, 2024
@Serpentiel Serpentiel enabled auto-merge (squash) April 4, 2024 10:46
@Serpentiel Serpentiel merged commit fc48e50 into aiven:main Apr 4, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants