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: update Ecosystem section #4817

Merged
merged 3 commits into from Sep 22, 2023
Merged

Docs: update Ecosystem section #4817

merged 3 commits into from Sep 22, 2023

Conversation

huynhicode
Copy link
Member

@huynhicode huynhicode commented Sep 7, 2023

📑 Summary

This PR updates the Ecosystem section of the Mermaid JS docs.

Updates:

  • add "Mermaid Chart" page
  • separate Integrations page into two pages ("Integrations - community" and "Integrations - create")
  • remove "Showcase" page
  • minor verbiage updates
  • content formatting

As a follow-up to this PR, it would be nice to add descriptions to the list of community plugins/integrations as not everyone who views the list will have knowledge about all the tools/technologies.

Also, a check to make sure all links are current.

Resolves # n/a

📏 Design Decisions

Design decisions come from within the Mermaid Chart org.

Screenshots:

Screenshot 2023-09-06 at 10 13 30 PM

📋 Tasks

Make sure you

@netlify
Copy link

netlify bot commented Sep 7, 2023

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 8a0ca8c
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/64fb59ebff91000008205417
😎 Deploy Preview https://deploy-preview-4817--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@huynhicode huynhicode requested a review from knsv September 7, 2023 05:12
@huynhicode huynhicode changed the base branch from develop to master September 7, 2023 05:25
Copy link
Collaborator

@knsv knsv left a comment

Choose a reason for hiding this comment

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

This looks great! Thank you Steph!

Copy link
Member

@sidharthv96 sidharthv96 left a comment

Choose a reason for hiding this comment

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

Please add the changed urls here so that old links don't break.

const urlRedirectMap: Record<string, string> = {
// Old URL: New URL
'/misc/faq.html': 'configure/faq.html',
'/syntax/c4c.html': 'syntax/c4.html',
'/config/n00b-advanced.html': 'config/advanced',
'/intro/n00b-gettingStarted.html': 'intro/getting-started',
'/intro/n00b-syntaxReference.html': 'intro/syntax-reference',
'/community/n00b-overview.html': 'intro/getting-started',
};

@huynhicode
Copy link
Member Author

Please add the changed urls here so that old links don't break.

const urlRedirectMap: Record<string, string> = {
// Old URL: New URL
'/misc/faq.html': 'configure/faq.html',
'/syntax/c4c.html': 'syntax/c4.html',
'/config/n00b-advanced.html': 'config/advanced',
'/intro/n00b-gettingStarted.html': 'intro/getting-started',
'/intro/n00b-syntaxReference.html': 'intro/syntax-reference',
'/community/n00b-overview.html': 'intro/getting-started',
};

Done - thanks!

@codecov
Copy link

codecov bot commented Sep 7, 2023

Codecov Report

Merging #4817 (8a0ca8c) into master (14c1c1c) will decrease coverage by 0.46%.
Report is 158 commits behind head on master.
The diff coverage is 68.37%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4817      +/-   ##
==========================================
- Coverage   73.93%   73.47%   -0.46%     
==========================================
  Files         145      146       +1     
  Lines       14653    14569      -84     
  Branches      562      592      +30     
==========================================
- Hits        10834    10705     -129     
- Misses       3706     3727      +21     
- Partials      113      137      +24     
Flag Coverage Δ
e2e 79.02% <75.42%> (-0.44%) ⬇️
unit 45.55% <41.26%> (-0.56%) ⬇️

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

Files Changed Coverage Δ
packages/mermaid/src/diagrams/c4/c4Diagram.ts 100.00% <ø> (ø)
packages/mermaid/src/diagrams/c4/svgDraw.js 87.65% <ø> (ø)
packages/mermaid/src/diagrams/class/classDb.ts 82.35% <ø> (-0.54%) ⬇️
...ages/mermaid/src/diagrams/class/classDiagram-v2.ts 60.00% <ø> (ø)
...ges/mermaid/src/diagrams/class/classRenderer-v2.ts 79.85% <ø> (ø)
...s/mermaid/src/diagrams/flowchart/flowDiagram-v2.ts 75.00% <ø> (ø)
...ackages/mermaid/src/diagrams/gantt/ganttDiagram.ts 100.00% <ø> (ø)
...ckages/mermaid/src/diagrams/git/gitGraphDiagram.ts 100.00% <ø> (ø)
packages/mermaid/src/diagrams/pie/pieDiagram.ts 100.00% <ø> (ø)
...aid/src/diagrams/quadrant-chart/quadrantDiagram.ts 100.00% <ø> (ø)
... and 35 more

... and 9 files with indirect coverage changes

@sidharthv96
Copy link
Member

@huynhicode, as showcases was removed, that should also be added to the redirect.

@huynhicode
Copy link
Member Author

@huynhicode, as showcases was removed, that should also be added to the redirect.

Done, thanks!

@knsv knsv merged commit fbe8d10 into master Sep 22, 2023
22 of 25 checks passed
@knsv knsv deleted the update-ecosystem-section branch September 22, 2023 06:45
fuxingloh pushed a commit to fuxingloh/contented that referenced this pull request Oct 25, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.5.0` ->
`10.5.1`](https://renovatebot.com/diffs/npm/mermaid/10.5.0/10.5.1) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.5.0/10.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.5.0/10.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>mermaid-js/mermaid (mermaid)</summary>

###
[`v10.5.1`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.5.1)

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v10.5.0...v10.5.1)

#### What's Changed

- Fix: Fix for subgraphs when using flowchart-elk by
[@&#8203;knsv](https://togithub.com/knsv)
- Docs: update Latest News section by
[@&#8203;huynhicode](https://togithub.com/huynhicode) in
[mermaid-js/mermaid#4822
- Docs: update Ecosystem section by
[@&#8203;huynhicode](https://togithub.com/huynhicode) in
[mermaid-js/mermaid#4817
- Docs: update Latest News section (Git Graph blog post) by
[@&#8203;huynhicode](https://togithub.com/huynhicode) in
[mermaid-js/mermaid#4871
- Docs: Add Product Hunt info by
[@&#8203;huynhicode](https://togithub.com/huynhicode) in
[mermaid-js/mermaid#4900
- Revert PH changes by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4903

**Full Changelog**:
mermaid-js/mermaid@v10.5.0...v10.5.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/levaintech/contented).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xOS4yIiwidXBkYXRlZEluVmVyIjoiMzcuMTkuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants