Repository navigation
Conversation
89f80fb to
4a1a09c
Compare
Running `npm start` emitted three classes of warning that we control: - `siteConfig.onBrokenMarkdownLinks` is deprecated and removed in Docusaurus v4. Moved it to `siteConfig.markdown.hooks.onBrokenMarkdownLinks`, keeping the `warn` severity so broken markdown links are still reported. - All seven blog posts lacked a truncation marker, so the blog list pages rendered each post in full. Added `<!-- truncate -->` after the opening paragraph of each post. - Duplicate route at `/standards/`: the vendored standards content pulled in by getDocs.js ships a README.md, which Docusaurus renders at the same route as our own standards/index.md. The standards docs plugin now excludes that README so index.md is unambiguously the page at `/standards/`. The remaining seven "Markdown link ... couldn't be resolved" warnings all originate in gitignored content vendored from upstream repositories, so they have to be fixed in those repositories rather than here. Committed with --no-verify: the pre-commit hook runs `markdownlint-cli2-fix`, a binary that markdownlint-cli2 v0.22 no longer ships. `prettier --check` and `markdownlint-cli2` were both run manually against these changes and pass. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Daniel Gerber <394442-gerbsen@users.noreply.gitlab.com>
Signed-off-by: Daniel Gerber <394442-gerbsen@users.noreply.gitlab.com>
4a1a09c to
c04d33c
Compare
- Add User-Agent header for lwn.net in mlc_config.json to avoid 401 responses from the markdown link checker - Add scs-health-monitor docs to docs.package.json so referenced files are fetched during the build Signed-off-by: Daniel Gerber <394442-gerbsen@users.noreply.gitlab.com>
7f92afb to
aaa4c45
Compare
| // own standards/index.md. Skip it; index.md is the page we want there. | ||
| // Repeats Docusaurus' default excludes, which this option replaces. | ||
| exclude: [ | ||
| 'README.md', |
There was a problem hiding this comment.
Why was this not necessary before?
Or is this a preliminary step before we alter getDocs.js to not delete README.md?
There was a problem hiding this comment.
The npm start said very explicitly:
[WARNING] Duplicate routes found!
- Attempting to create page at /standards/, but a page already exists at this route.
This could lead to non-deterministic routing behavior.
There was a problem hiding this comment.
I don't get this error with "main".
There was a problem hiding this comment.
Is this question resolved? Should we deploy to staging once more for comparison?
There was a problem hiding this comment.
Please give me some time to reevaluate this, might be resolved.
There was a problem hiding this comment.
So I rebased this and removed the scs-health-monitor (which is archived). I now get this for npm run build && npm run serve. So I have to fix all of these warnings. Why does this not break the current build @garloff ?
[WARNING] @docusaurus/plugin-client-redirects: some redirects would override existing paths, and will be ignored:
- {"from":"/standards/scs-compatible-iaas","to":"/standards/scopes/scs-0501"}
- {"from":"/standards/scs-compatible-kaas","to":"/standards/scopes/scs-0502"}
[WARNING] Docusaurus found broken links!
Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
Exhaustive list of all broken links found:
- Broken link on source page path = /docs/:
-> linking to /docs/operating-scs/components/scs-health-monitor/overview
-> linking to /docs/container/components/cluster-stacks/providers/openstack/quickstart
- Broken link on source page path = /docs/faq/:
-> linking to /community/governance/project-board
- Broken link on source page path = /user-docs/application-examples/opendesk-on-scs/getting_started:
-> linking to helper/deploy-openDesk (resolved as: /user-docs/application-examples/opendesk-on-scs/helper/deploy-openDesk)
[WARNING] Docusaurus found broken anchors!
Please check the pages of your site in the list below, and make sure you don't reference any anchor that does not exist.
Note: it's possible to ignore broken anchors with the 'onBrokenAnchors' Docusaurus configuration, and let the build pass.
Exhaustive list of all broken anchors found:
- Broken anchor on source page path = /docs/container/components/container-registry/docs/migration:
-> linking to /docs/container/components/container-registry/docs/backup_and_restore#backup-and-restore
- Broken anchor on source page path = /docs/releases/Release1:
-> linking to #Known-Issue-with-OIDC-Logout (resolved as: /docs/releases/Release1#Known-Issue-with-OIDC-Logout)
-> linking to #non-TLS-restrictions-testbed (resolved as: /docs/releases/Release1#non-TLS-restrictions-testbed)
There was a problem hiding this comment.
Maybe the checkout is not clean. What do you get from git status?
|
See https://docs-staging.scs.community/blog/ Blog posts are now truncated in the listing. I think this is an improvement. However, it's a change, so let's ask @garloff and @fkr whether it's okay. |
|
I'm also in the camp "improvement". |
|
+1 for truncating, because currently it feels like an endless wall to scroll especially on mobile. |
|
I still get these 3 warnings: |
|
I like what this patch is doing! |
Signed-off-by: Kurt Garloff <kurt@garloff.de>
|
This requires #408 to pass CI. |
|
@garloff There is still one unresolved discussion. The proverbial ball is in @gerbsen's field -- I don't think my question has been answered in a satisfactory way, given that @depressiveRobot was not able to reproduce the error that was talked about there. |
I don't know if this is still the case, but I don't think we need to address ALL the warnings with this PR. Reducing the number significantly would be a win already. |
Signed-off-by: Kurt Garloff <kurt@garloff.de>
|
Should we just back out the README.md exclusion and then merge and allow for @gerbsen to open another separate PR where that can be discussed? |
I was a little annoyed by all the warnings once you start the server, so I thought it might be a good idea to get rid of them. There were quite a lot of links which I manually resolved to new pages due to the osism removal and archival of the health-monitor repo. I also bumped the version of Docusaurus to the most recent one: works on my machinel™.
One thing I would like to change in the future: brokens links are considered a real problem and break the complete build process. I think if we already have the possibility to check that all links work, then we should use it.