SovereignCloudStack / SovereignCloudStack/docs

Syntax problems on "main" branch

Open
#269 0 comments 0 reactions 1 assignee View on GitHub

@maxwolfs is already working on this.

Since Oct 28, 2024.

Dominant language
JavaScript
Stars
18
Forks
10
Avg merge
15h 16m
Merged PRs (30d)
2

Description

Linting complains:

$ npm run lint:md

> docs@1.0.0 lint:md
> markdownlint-cli2 "**/*.md"

markdownlint-cli2 v0.7.1 (markdownlint v0.28.2)
Finding: **/*.md **/*.{md} !node_modules !.github !docs !standards
Linting: 49 file(s)
Summary: 2 error(s)
user-docs/application-examples/opendesk-on-scs/quickstart.md:3:56 search-replace Custom rule [relative-link-path: Don't use relative paths] [Context: "column: 56 text:'](..'"]
user-docs/application-examples/opendesk-on-scs/quickstart.md:26:31 search-replace Custom rule [relative-link-path: Don't use relative paths] [Context: "column: 31 text:'](..'"]

When starting a local development server, i get a huge amount of error messages.

$ npm start

> docs@1.0.0 start
> docusaurus start


 ------------------------------------------------------------------------------------------------------------------------------------                                                                                                                                                                                           Update available 3.2.1 → 3.5.2                                                                                                                                                                                                                    To upgrade Docusaurus packages with the latest version, run the following command:                                       `npm i @docusaurus/core@latest @docusaurus/plugin-client-redirects@latest @docusaurus/preset-classic@latest                            @docusaurus/theme-mermaid@latest @docusaurus/eslint-plugin@latest @docusaurus/module-type-aliases@latest                                                        @docusaurus/tsconfig@latest @docusaurus/types@latest`                                                                                                                                                                                ------------------------------------------------------------------------------------------------------------------------------------ 

[INFO] Starting the development server...
[SUCCESS] Docusaurus website is running at: http://localhost:3000/

✖ Client
  Compiled with some errors in 2.57s

Error: MDX compilation failed for file "/home/marc/src/github/osba/scs/docs/docs/02-iaas/components/image-manager.md"
Cause: Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)
Details:
{
  "column": 8,
  "message": "Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)",
  "line": 29,
  "name": "29:8",
  "place": {
    "line": 29,
    "column": 8,
    "offset": 974,
    "_index": 47,
    "_bufferIndex": 7
  },
  "reason": "Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)",
  "ruleId": "unexpected-character",
  "source": "micromark-extension-mdx-jsx",
  "url": "https://github.com/micromark/micromark-extension-mdx-jsx#unexpected-character-at-expected-expect"
}

--------------------------

Error: MDX compilation failed for file "/home/marc/src/github/osba/scs/docs/docs/02-iaas/deployment-examples/cloud-in-a-box/advanced-guides/cloud-in-a-box.md"
Cause: Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)
Details:
{
  "column": 36,
  "message": "Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)",
  "line": 110,
  "name": "110:36",
  "place": {
    "line": 110,
    "column": 36,
    "offset": 4682,
    "_index": 0,
    "_bufferIndex": 7
  },
  "reason": "Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)",
  "ruleId": "unexpected-character",
  "source": "micromark-extension-mdx-jsx",
  "url": "https://github.com/micromark/micromark-extension-mdx-jsx#unexpected-character-at-expected-expect"
}

--------------------------

Error: MDX compilation failed for file "/home/marc/src/github/osba/scs/docs/docs/02-iaas/deployment-examples/cloud-in-a-box/advanced-guides/testbed.md"
Cause: Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)
Details:
{
  "column": 11,
  "message": "Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)",
  "line": 351,
  "name": "351:11",
  "place": {
    "line": 351,
    "column": 11,
    "offset": 14871,
    "_index": 4,
    "_bufferIndex": 7
  },
  "reason": "Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)",
  "ruleId": "unexpected-character",
  "source": "micromark-extension-mdx-jsx",
  "url": "https://github.com/micromark/micromark-extension-mdx-jsx#unexpected-character-at-expected-expect"
}
client (webpack 5.94.0) compiled with 3 errors
<w> [webpack.cache.PackFileCacheStrategy] Skipped not serializable cache item 'Compilation/modules|/home/marc/src/github/osba/scs/docs/node_modules/@docusaurus/mdx-loader/lib/index.js??ruleSet[1].rules[8].use[0]!/home/marc/src/github/osba/scs/docs/node_modules/@docusaurus/plugin-content-docs/lib/markdown/index.js??ruleSet[1].rules[8].use[1]!/home/marc/src/github/osba/scs/docs/docs/02-iaas/components/image-manager.md': No serializer registered for VFileMessage
<w> while serializing webpack/lib/cache/PackFileCacheStrategy.PackContentItems -> webpack/lib/NormalModule -> webpack/lib/ModuleBuildError -> Error -> VFileMessage
<w> [webpack.cache.PackFileCacheStrategy] Skipped not serializable cache item 'Compilation/modules|/home/marc/src/github/osba/scs/docs/node_modules/@docusaurus/mdx-loader/lib/index.js??ruleSet[1].rules[8].use[0]!/home/marc/src/github/osba/scs/docs/node_modules/@docusaurus/plugin-content-docs/lib/markdown/index.js??ruleSet[1].rules[8].use[1]!/home/marc/src/github/osba/scs/docs/docs/02-iaas/deployment-examples/cloud-in-a-box/advanced-guides/cloud-in-a-box.md': No serializer registered for VFileMessage
<w> while serializing webpack/lib/cache/PackFileCacheStrategy.PackContentItems -> webpack/lib/NormalModule -> webpack/lib/ModuleBuildError -> Error -> VFileMessage
<w> [webpack.cache.PackFileCacheStrategy] Skipped not serializable cache item 'Compilation/modules|/home/marc/src/github/osba/scs/docs/node_modules/@docusaurus/mdx-loader/lib/index.js??ruleSet[1].rules[8].use[0]!/home/marc/src/github/osba/scs/docs/node_modules/@docusaurus/plugin-content-docs/lib/markdown/index.js??ruleSet[1].rules[8].use[1]!/home/marc/src/github/osba/scs/docs/docs/02-iaas/deployment-examples/cloud-in-a-box/advanced-guides/testbed.md': No serializer registered for VFileMessage
<w> while serializing webpack/lib/cache/PackFileCacheStrategy.PackContentItems -> webpack/lib/NormalModule -> webpack/lib/ModuleBuildError -> Error -> VFileMessage

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.