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

Upgrade Docusaurus to V3 and fixes #175

Merged
merged 14 commits into from
Apr 8, 2024
Merged

Upgrade Docusaurus to V3 and fixes #175

merged 14 commits into from
Apr 8, 2024

Conversation

maxwolfs
Copy link
Member

Upgrade and relevant fixes to the new md rules coming with it. This is only fixing the markdown errors with the markdown files within this repository. There are still 14 compilation that prevent from building. Those have to be fixed in other repositories. See parent issue #113

Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
@mbuechse mbuechse linked an issue Mar 27, 2024 that may be closed by this pull request
3 tasks
@maxwolfs maxwolfs requested a review from mbuechse March 27, 2024 14:07
@@ -44,7 +44,7 @@ line to commit messages.
```bash
My fancy commit message

Signed-off-by: Christian Berendt <[email protected]>
Signed-off-by: Christian Berendt <$[email protected]>
Copy link
Contributor

Choose a reason for hiding this comment

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

I can live fine with most changes, but this seems wrong.

Copy link
Contributor

Choose a reason for hiding this comment

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

Screenshot from 2024-04-02 17-28-28
No, this is a code segment, so the escape character will not be interpreted. Why did you put it in there?

Copy link
Member

Choose a reason for hiding this comment

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

While touching this, can we change the sample mail address to [email protected] ?

docs/glossary.md Outdated Show resolved Hide resolved
package.json Outdated
"@docusaurus/preset-classic": "^2.4.3",
"@docusaurus/theme-mermaid": "^2.4.3",
"@easyops-cn/docusaurus-search-local": "^0.33.6",
"@docusaurus/core": "^3.1.1",
Copy link
Member

Choose a reason for hiding this comment

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

Docusaurus 3.2.0 is out now. I think it makes sense to change this before the merge of this PR.

Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
@maxwolfs maxwolfs merged commit bcf3f86 into main Apr 8, 2024
4 checks passed
@maxwolfs maxwolfs deleted the feat/v3-upgrade branch April 8, 2024 06:41
JuanPTM pushed a commit to JuanPTM/docs that referenced this pull request Jun 3, 2024
* upgrade dependencies

Signed-off-by: Max Wolfs <[email protected]>

* fix glossary

Signed-off-by: Max Wolfs <[email protected]>

* fix new md rules

Signed-off-by: Max Wolfs <[email protected]>

* fix md errors

Signed-off-by: Max Wolfs <[email protected]>

* fix reviews comment

Signed-off-by: Max Wolfs <[email protected]>

* remove pointless escaping

Signed-off-by: Max Wolfs <[email protected]>

* update to 3.2.0

Signed-off-by: Max Wolfs <[email protected]>

* change sample mail address

Signed-off-by: Max Wolfs <[email protected]>

* bump node

Signed-off-by: Max Wolfs <[email protected]>

* fix md linting typo

Signed-off-by: Max Wolfs <[email protected]>

* update docusaurus

Signed-off-by: Max Wolfs <[email protected]>

* fix url

Signed-off-by: Max Wolfs <[email protected]>

* fix link

Signed-off-by: Max Wolfs <[email protected]>

---------

Signed-off-by: Max Wolfs <[email protected]>
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.

Upgrade docusaurus to version 3
3 participants