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.

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

Enable Mermaid diagrams in Docusaurus #3532

Merged
merged 6 commits into from Oct 13, 2023
Merged

Enable Mermaid diagrams in Docusaurus #3532

merged 6 commits into from Oct 13, 2023

Conversation

sid-js
Copy link
Contributor

@sid-js sid-js commented Oct 9, 2023 •
edited by AlekSi

Description

Closes #3528.

Added Mermaid Diagrams Plugin in Configuration of Docs and Blogs of website

Readiness checklist

  • I added/updated unit tests (and they pass).
  • I added/updated integration/compatibility tests (and they pass).
  • I added/updated comments and checked rendering.
  • I made spot refactorings.
  • I updated user documentation.
  • I ran task all, and it passed.
  • I ensured that PR title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Milestone (Next), Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@CLAassistant
Copy link

CLAassistant commented Oct 9, 2023 •
edited

CLA assistant check
All committers have signed the CLA.

@mergify mergify bot assigned sid-js Oct 9, 2023
AlekSi
AlekSi reviewed Oct 9, 2023
View reviewed changes
Copy link
Member

@AlekSi AlekSi left a comment •
edited

Choose a reason for hiding this comment

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

Could you please add an example diagram somewhere to demonstrate that it works?

(it would not work because the Docusaurus dependency wasn't updated: https://github.com/FerretDB/FerretDB/actions/runs/6456277919/job/17551548074?pr=3532)

@AlekSi AlekSi added the code/chore Code maintenance improvements label Oct 9, 2023
@Fashander Fashander requested review from a team and Fashander October 9, 2023 15:24
@codecov
Copy link

codecov bot commented Oct 10, 2023 •
edited

Codecov Report

Merging #3532 (5061549) into main (ce4945d) will increase coverage by 3.51%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #3532      +/-   ##
==========================================
+ Coverage   57.97%   61.49%   +3.51%     
==========================================
  Files         420      426       +6     
  Lines       26909    27225     +316     
==========================================
+ Hits        15601    16741    +1140     
+ Misses      10287     9494     -793     
+ Partials     1021      990      -31

see 87 files with indirect coverage changes

Flag Coverage Δ
filter-true 57.97% <ø> (ø)
hana-1 2.89% <ø> (ø)
integration 57.97% <ø> (ø)
mongodb-1 4.50% <ø> (ø)
postgresql-1 41.01% <ø> (+<0.01%) ⬆️
postgresql-2 40.77% <ø> (+<0.01%) ⬆️
postgresql-3 39.60% <ø> (ø)
sort-false 57.97% <ø> (ø)
sqlite-1 40.93% <ø> (-0.10%) ⬇️
sqlite-2 41.30% <ø> (ø)
sqlite-3 39.51% <ø> (ø)
unit 22.41% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

@sid-js
Copy link
Contributor Author

sid-js commented Oct 11, 2023

Could you please add an example diagram somewhere to demonstrate that it works?

(it would not work because the Docusaurus dependency wasn't updated: https://github.com/FerretDB/FerretDB/actions/runs/6456277919/job/17551548074?pr=3532)

I thought it was updated here : FerretDB/deps@73ca957

@AlekSi
Copy link
Member

AlekSi commented Oct 11, 2023

It was, but the tag of the Docker image wasn't updated in this PR

@AlekSi AlekSi changed the title feat. Enable Mermaid Diagrams in Docs & Blogs Enable Mermaid diagrams in Docusaurus Oct 12, 2023
@AlekSi AlekSi added documentation Something user-visible is badly or not documented trust PRs that can access Actions secrets not ready Issues that are not ready to be worked on; PRs that should skip CI and removed not ready Issues that are not ready to be worked on; PRs that should skip CI labels Oct 12, 2023
@AlekSi
Copy link
Member

AlekSi commented Oct 12, 2023

@sid-js Please click the CLA button in this comment: #3532 (comment)

@AlekSi AlekSi enabled auto-merge (squash) October 13, 2023 15:56
@AlekSi AlekSi self-requested a review October 13, 2023 15:56
@AlekSi AlekSi added this to the Next milestone Oct 13, 2023
@AlekSi
Copy link
Member

AlekSi commented Oct 13, 2023

@Fashander PTAL

@AlekSi AlekSi merged commit ff92b03 into FerretDB:main Oct 13, 2023
27 of 28 checks passed
@AlekSi
Copy link
Member

AlekSi commented Oct 13, 2023

@sid-js Merged, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlekSi AlekSi AlekSi approved these changes

@Fashander Fashander Fashander approved these changes

@ptrfarkas ptrfarkas Awaiting requested review from ptrfarkas ptrfarkas is a code owner

Assignees

@Fashander Fashander

@sid-js sid-js

Labels
code/chore Code maintenance improvements documentation Something user-visible is badly or not documented trust PRs that can access Actions secrets
Projects
Current Engineering
Archived in project
Milestone
v1.13.0
Development

Successfully merging this pull request may close these issues.

Enable Mermaid diagrams in Docusaurus
4 participants
@sid-js @CLAassistant @AlekSi @Fashander