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: Fix a couple of broken link fragments #6197

Merged
merged 1 commit into from
May 16, 2024

Conversation

rfay
Copy link
Member

@rfay rfay commented May 16, 2024

The Issue

Two Markdown link fragments were broken, and markdownlint was catching it, at least locally.

@rfay rfay requested a review from a team as a code owner May 16, 2024 17:22
@stasadev
Copy link
Member

Most likely, the local mkdocs is a bit out of date.

I don't see any warnings in the master build:
https://github.com/ddev/ddev/actions/runs/9104906004/job/25029576983#step:6:89

@rfay rfay merged commit 41f38c7 into ddev:master May 16, 2024
10 of 12 checks passed
@rfay rfay deleted the 20240516_markdown_problems branch May 16, 2024 17:27
@rfay
Copy link
Member Author

rfay commented May 16, 2024

It's actually the markdownlint check that gets it, which is done in docs check. I have markdownlint 0.40.0

@rfay
Copy link
Member Author

rfay commented May 16, 2024

Oh, we're using https://github.com/avto-dev/markdown-lint - which is using a vastly outdated markdownlint, seems unmaintained?

@stasadev
Copy link
Member

I see, but now mkdocs complains:

INFO    -  Doc file 'developers/release-management.md' contains a link '#maintaining-ddev-dbserver-mysql-57--80-arm64-images', but there is no such
           anchor on this page.
INFO    -  Doc file 'developers/testing-docs.md' contains a link '#fork--clone-the-ddev-repository', but there is no such anchor on this page.

And this link doesn't work http://127.0.0.1:8000/en/stable/developers/testing-docs/#fork--clone-the-ddev-repository

But the previous link does http://127.0.0.1:8000/en/stable/developers/testing-docs/#fork-clone-the-ddev-repository

@rfay
Copy link
Member Author

rfay commented May 16, 2024

@rfay
Copy link
Member Author

rfay commented May 16, 2024

I agree with you.

  1. The links that I used were the ones suggested by Goland (mkdocs integration)
  2. They fixed the markdownlint-cli (0.40.0) complaints with current markdownlint
  3. They passed our docs check anyway, but that's because our markdownlint github action is vastly out of date
  4. markdownlint-cli had its new release 2 weeks ago, and I ended up with it in homebrew.

So this should be reverted and I'll have to figure out my local checks I guess.

rfay added a commit to rfay/ddev that referenced this pull request May 16, 2024
@stasadev
Copy link
Member

Oh, we're using avto-dev/markdown-lint - which is using a vastly outdated markdownlint

The linter in GitHub actions doesn't seem to be complaining at all.

https://github.com/ddev/ddev/actions/runs/9104906017/job/25029577157#step:10:9


markdownlint-cli had its new release 2 weeks ago, and I ended up with it in homebrew.

Yes, I have the same release and see the same errors in make staticrequired.

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

Successfully merging this pull request may close these issues.

None yet

2 participants