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: Integrations - Community page (reorder integrations and check links) #4974

Closed
huynhicode opened this issue Oct 22, 2023 · 6 comments · Fixed by #5066
Closed

Docs: Integrations - Community page (reorder integrations and check links) #4974

huynhicode opened this issue Oct 22, 2023 · 6 comments · Fixed by #5066

Comments

@huynhicode
Copy link
Member

Description

This is not a bug. Using this template as it is the most fitting.

The Integrations - Community page currently lists community integrations.

It would be good to go through the list of community integrations to see if the links are current and active.

Nice to have:

  • remove duplicates
  • reorder alphabetically in the respective section
  • add a brief summary about the integration

Steps to reproduce

  1. Go to the Integrations - Community page
  2. View the list of community integrations
  3. Click on each link to be taken to the respective page
  4. Verify that the link is current and active

Screenshots

n/a

Code Sample

n/a

Setup

n/a

Suggested Solutions

See above.

Additional Context

Good first issue!

Thanks in advance for the docs assistance! 😀

@huynhicode huynhicode added Type: Bug / Error Something isn't working or is incorrect Status: Triage Needs to be verified, categorized, etc labels Oct 22, 2023
@huynhicode
Copy link
Member Author

This is a follow-up issue to PR-4975.

@huynhicode huynhicode added Area: Documentation Good first issue! and removed Type: Bug / Error Something isn't working or is incorrect Status: Triage Needs to be verified, categorized, etc labels Oct 24, 2023
@martinez-hugo
Copy link

Hi ! Can I work on this issue ?

@huynhicode
Copy link
Member Author

@martinez-hugo Please! Thanks for your contribution!

Let me know if you have any questions.

@martinez-hugo
Copy link

Hello @huynhicode

I just try to update doc (in packages/mermaid/src/docs folder) and commit but I have this error on console when I commit :

> git -c user.useConfigOnly=true commit --quiet --allow-empty-message --file -

> [email protected] pre-commit /Users/hugomartinez/mermaid
> lint-staged

[STARTED] Preparing lint-staged...
[SUCCESS] Preparing lint-staged...
[STARTED] Running tasks for staged files...
[STARTED] packages/mermaid/.lintstagedrc.mjs — 1 file
[STARTED] !(docs/**/*)*.{ts,js,html,md,mts} — 1 file
[STARTED] cSpell.json — 0 files
[STARTED] **/*.jison — 0 files
[STARTED] src/docs/** — 1 file
[STARTED] src/docs.mts — 0 files
[STARTED] src/(defaultConfig|config|mermaidAPI).ts — 0 files
[STARTED] src/schemas/config.schema.yaml — 0 files
[SKIPPED] cSpell.json — no files
[SKIPPED] **/*.jison — no files
[SKIPPED] src/docs.mts — no files
[SKIPPED] src/(defaultConfig|config|mermaidAPI).ts — no files
[SKIPPED] src/schemas/config.schema.yaml — no files
[STARTED] eslint --cache --cache-strategy content --fix
[STARTED] pnpm --filter mermaid run docs:build --git
[SUCCESS] eslint --cache --cache-strategy content --fix
[STARTED] prettier --write
[SUCCESS] prettier --write
[SUCCESS] !(docs/**/*)*.{ts,js,html,md,mts} — 1 file
[FAILED] pnpm --filter mermaid run docs:build --git [FAILED]
[FAILED] pnpm --filter mermaid run docs:build --git [FAILED]
[FAILED] pnpm --filter mermaid run docs:build --git [FAILED]
[STARTED] Applying modifications from tasks...
[SKIPPED] Skipped because of errors from tasks.
[STARTED] Reverting to original state because of errors...
[SUCCESS] Reverting to original state because of errors...
[STARTED] Cleaning up temporary files...
[SUCCESS] Cleaning up temporary files...

✖ pnpm --filter mermaid run docs:build --git:

 1/45 ./src/docs/community/code.md 253.76ms

 2/45 ./src/docs/community/development.md 11.97ms

 3/45 ./src/docs/community/docker-development.md 6.75ms

 4/45 ./src/docs/community/documentation.md 10.57ms

 5/45 ./src/docs/community/newDiagram.md 14.34ms

 6/45 ./src/docs/community/questions-and-suggestions.md 9.06ms

 7/45 ./src/docs/community/security.md 8.38ms

 8/45 ./src/docs/config/8.6.0_docs.md 8.20ms

 9/45 ./src/docs/config/accessibility.md 6.74ms

10/45 ./src/docs/config/advanced.md 2.00ms

11/45 ./src/docs/config/configuration.md 4.46ms

12/45 ./src/docs/config/directives.md 1.98ms

13/45 ./src/docs/config/faq.md 2.91ms

14/45 ./src/docs/config/mermaidCLI.md 1.54ms

15/45 ./src/docs/config/theming.md 16.85ms

16/45 ./src/docs/config/Tutorials.md 7.48ms

17/45 ./src/docs/config/usage.md 5.13ms

18/45 ./src/docs/ecosystem/integrations-community.md 21.94ms

19/45 ./src/docs/ecosystem/integrations-create.md 3.24ms

20/45 ./src/docs/ecosystem/mermaid-chart.md 5.36ms

21/45 ./src/docs/index.md 3.97ms

22/45 ./src/docs/intro/examples.md 1.45ms

23/45 ./src/docs/intro/getting-started.md 5.75ms

24/45 ./src/docs/intro/index.md 18.60ms

25/45 ./src/docs/intro/syntax-reference.md 8.40ms

26/45 ./src/docs/news/announcements.md 3.50ms

27/45 ./src/docs/news/blog.md 19.47ms

28/45 ./src/docs/syntax/c4.md 14.61ms

29/45 ./src/docs/syntax/classDiagram.md 4.92ms

30/45 ./src/docs/syntax/entityRelationshipDiagram.md 5.83ms

31/45 ./src/docs/syntax/examples.md 7.67ms

32/45 ./src/docs/syntax/flowchart.md 4.96ms

33/45 ./src/docs/syntax/gantt.md 8.20ms

34/45 ./src/docs/syntax/gitgraph.md 13.58ms

35/45 ./src/docs/syntax/mindmap.md 9.55ms

36/45 ./src/docs/syntax/pie.md 5.37ms

37/45 ./src/docs/syntax/quadrantChart.md 3.98ms

38/45 ./src/docs/syntax/requirementDiagram.md 2.54ms

39/45 ./src/docs/syntax/sankey.md 7.03ms

40/45 ./src/docs/syntax/sequenceDiagram.md 7.50ms

41/45 ./src/docs/syntax/stateDiagram.md 4.18ms

42/45 ./src/docs/syntax/timeline.md 4.51ms

43/45 ./src/docs/syntax/userJourney.md 2.89ms

44/45 ./src/docs/syntax/xyChart.md 6.56ms

45/45 ./src/docs/syntax/zenuml.md 2.40ms
CSpell: Files checked: 45, Issues found: 0 in 0 files
�[93m[warning]�[0m MermaidConfig, defined in ./src/config.type.ts, is referenced by config.defaultConfig but not included in the documentation.
�[93m[warning]�[0m DiagramStyleClassDef, defined in ./src/diagram-api/types.ts, is referenced by mermaidAPI.createCssStyles.createCssStyles.classDefs but not included in the documentation.
�[93m[warning]�[0m Diagram, defined in ./src/Diagram.ts, is referenced by mermaidAPI.mermaidAPI.__type.getDiagramFromText.__type.__type but not included in the documentation.
�[93m[warning]�[0m DiagramMetadata, defined in ./src/diagram-api/types.ts, is referenced by mermaidAPI.mermaidAPI.__type.getDiagramFromText.__type.__type.metadata but not included in the documentation.
�[93m[warning]�[0m Failed to resolve link to "UnknownDiagramError" in comment for mermaidAPI.mermaidAPI.__type.getDiagramFromText.__type.
TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".mts" for /Users/hugomartinez/mermaid/packages/mermaid/scripts/docs.cli.mts
    at new NodeError (node:internal/errors:405:5)
    at Object.getFileProtocolModuleFormat [as file:] (node:internal/modules/esm/get_format:99:9)
    at defaultGetFormat (node:internal/modules/esm/get_format:142:36)
    at defaultLoad (node:internal/modules/esm/load:120:20)
    at nextLoad (node:internal/modules/esm/hooks:832:28)
    at load (/Users/hugomartinez/mermaid/node_modules/.pnpm/[email protected]_@[email protected][email protected]/node_modules/ts-node/dist/child/child-loader.js:19:122)
    at nextLoad (node:internal/modules/esm/hooks:832:28)
    at Hooks.load (node:internal/modules/esm/hooks:415:26)
    at MessagePort.handleMessage (node:internal/modules/esm/worker:168:24)
    at [nodejs.internal.kHybridDispatch] (node:internal/event_target:807:20) {
  code: 'ERR_UNKNOWN_FILE_EXTENSION'
}

> [email protected] docs:build /Users/hugomartinez/mermaid/packages/mermaid
> rimraf ../../docs && pnpm docs:spellcheck && pnpm docs:code && ts-node-esm scripts/docs.cli.mts "--git" "/Users/hugomartinez/mermaid/packages/mermaid/src/docs/ecosystem/integrations-community.md"


> [email protected] docs:spellcheck /Users/hugomartinez/mermaid/packages/mermaid
> cspell --config ../../cSpell.json "src/docs/**/*.md"


> [email protected] docs:code /Users/hugomartinez/mermaid/packages/mermaid
> typedoc src/defaultConfig.ts src/config.ts src/mermaidAPI.ts && prettier --write ./src/docs/config/setup

�[96m[info]�[0m Loaded plugin typedoc-plugin-markdown
�[96m[info]�[0m Documentation generated at ./src/docs/config/setup
src/docs/config/setup/interfaces/mermaidAPI.ParseOptions.md 25ms
src/docs/config/setup/interfaces/mermaidAPI.RenderResult.md 38ms
src/docs/config/setup/modules/config.md 24ms
src/docs/config/setup/modules/defaultConfig.md 4ms
src/docs/config/setup/modules/mermaidAPI.md 139ms
src/docs/config/setup/README.md 2ms
undefined
 ERR_PNPM_RECURSIVE_RUN_FIRST_FAIL  [email protected] docs:build: `rimraf ../../docs && pnpm docs:spellcheck && pnpm docs:code && ts-node-esm scripts/docs.cli.mts "--git" "/Users/hugomartinez/mermaid/packages/mermaid/src/docs/ecosystem/integrations-community.md"`
Exit status 1
 ELIFECYCLE  Command failed with exit code 1.
husky - pre-commit hook exited with code 1 (error)

Can you help me ?

Thanks for all,

@sidharthv96
Copy link
Member

Which version of node do you use @martinez-hugo ?

@martinez-hugo
Copy link

I use node in v21.1.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants