Draft: Fix internal links #28
Conversation
add ssh deployment
- replace links into generated Java API pages to appropriate source code - replace internal links to internal pages which are not part of operator with external links - extract svg into separate files to fix JSX build fix image
|
Thank you @maxistar , we'll check your PR |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes internal links throughout the documentation by updating broken link paths, standardizing link formats, and improving the JSX build process. The changes address navigation issues and enhance documentation maintainability.
- Updates internal documentation links to use correct relative paths and
.mdextensions - Replaces non-existent internal links with appropriate external alternatives
- Fixes link formatting issues that were preventing proper navigation
Reviewed Changes
Copilot reviewed 73 out of 161 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/security/index.md | Fixed link to user guide security documentation |
| docs/get-started/spring-boot/configuration.md | Updated link to configuration documentation |
| docs/get-started/quick-start/decision-automation.md | Fixed BPMN and DMN reference links |
| docs/get-started/dmn/*.md | Updated various DMN tutorial links to proper paths |
| docs/get-started/archive/javaee7/*.md | Fixed cross-references between tutorial sections |
| docs/get-started/archive/java-process-app/*.md | Updated internal tutorial navigation links |
| docs/get-started/apache-maven.md | Fixed links to various Operaton module documentation |
| docs/documentation/webapps/*.md | Updated Java API references to GitHub source links |
| docs/documentation/user-guide/*.md | Standardized links throughout user guide sections |
| docs/documentation/reference/*.md | Fixed reference documentation cross-links |
Comments suppressed due to low confidence (1)
docs/documentation/reference/deployment-descriptors/tags/process-engine.md:1
- The HTML entity encoding
{and}should be simplified to{h2, mysql, oracle, postgres, mssql, db2, mariadb}for better readability, as modern markdown processors handle curly braces in text content correctly.
---
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Thanks also from my side @maxistar. 161 files is a lot to check. But we will handle this. :) |
kthoms
left a comment
kthoms
left a comment
There was a problem hiding this comment.
Please fix the relative paths.
broken-link-checker did not work for me. It did not actually verify all pages recursive. It just evaluated the main page.
|
|
||
| :::note[Wildfly Application Server] | ||
| Wildfly Application Server is provided as part of the archives as a convenience. For a copy of the source code, the full set of attribution notices, and other relevant information please see https://github.com/wildfly/wildfly. We will also provide you with a copy of the source code if you [contact our Open-Source Compliance Team](https://docs.operaton.org/manual/latest/introduction/licenses/#contact) at any time within three years of you downloading an archive (for which we may charge a nominal sum). Wildfly Application Server is copyright © JBoss, Home of Professional Open Source, 2010, Red Hat Middleware LLC [..and contributors]. | ||
| Wildfly Application Server is provided as part of the archives as a convenience. For a copy of the source code, the full set of attribution notices, and other relevant information please see https://github.com/wildfly/wildfly. We will also provide you with a copy of the source code if you [contact our Open-Source Compliance Team](../introduction/licenses.md#contact) at any time within three years of you downloading an archive (for which we may charge a nominal sum). Wildfly Application Server is copyright © JBoss, Home of Professional Open Source, 2010, Red Hat Middleware LLC [..and contributors]. |
There was a problem hiding this comment.
A general issue in this PR:
Relative paths starting with ../: When the target is in the same directory, leave out the prefix.
In this case the right target is just licenses.md#contact.
4 participants
fixed docusaurus build
fix internal links
replaced links into generated Java API pages to appropriate source code
replaced internal links to internal pages which are not part of operaton with external links
extract svg into separate files to fix JSX build
The number of broken links reduced from 3K to 1K
the links where checked with command 'npx broken-link-checker http://localhost:3000 --recursive'
following steps
this PR is part if #1
I realised that we have javadoc already: I will update these links in separate ticket: this will decrease number of changes in this PR