Yilialinn opened a new pull request, #2043:
URL: https://github.com/apache/apisix-website/pull/2043

   ## Summary
   
   Fix doc workspace build failures by converting relative links to absolute 
URLs for paths that exist in the website workspace but not in the doc workspace.
   
   ## Problem
   
   The doc build has been failing since May 13, 2026 with:
   ```
   [06:48:20] Build website's all parts [failed]
   [06:48:20] → Build failed for: doc
   Error: Build failed for: doc
   info Docusaurus found broken links!
   ```
   
   **Root cause:** The apisix-website repository uses separate Docusaurus 
workspaces (`doc`, `website`, `blog`) that build independently and are then 
assembled. During the doc workspace build, Docusaurus validates all links in 
the navbar and footer. Links pointing to paths that exist in the website 
workspace (`/`, `/blog`, `/learning-center`, `/downloads`, `/help`, `/team`, 
`/showcase`, `/plugins`) fail validation because these paths don't exist in the 
doc workspace.
   
   ## Solution
   
   Convert cross-workspace navigation links from relative paths to absolute 
URLs using `https://apisix.apache.org/`. This prevents Docusaurus from 
validating them as internal links while maintaining the same user experience 
(links work correctly with `target='_parent'`).
   
   ### Changes Made
   
   **config/navbar.js:**
   - Learning Center: `/learning-center` → 
`https://apisix.apache.org/learning-center/`
   - Blog: `/blog` → `https://apisix.apache.org/blog/`  
   - Case Studies: `/blog/tags/case-studies` → 
`https://apisix.apache.org/blog/tags/case-studies/`
   - Downloads: `/downloads` → `https://apisix.apache.org/downloads/`
   - Help: `/help` → `https://apisix.apache.org/help/`
   - Team: `team` → `https://apisix.apache.org/team/`
   - Showcase: `/showcase` → `https://apisix.apache.org/showcase/`
   - PluginHub: `/plugins` → `https://apisix.apache.org/plugins/`
   
   **doc/src/theme/Footer/index.tsx:**
   - Blog: `/blog/` → `https://apisix.apache.org/blog/`
   - Showcase: `/showcase` → `https://apisix.apache.org/showcase/`
   - Plugin Hub: `/plugins` → `https://apisix.apache.org/plugins/`
   
   **doc/src/theme/NotFound/index.tsx:**
   - Homepage: `/` → `https://apisix.apache.org/`
   
   ## Why This Approach?
   
   1. **Maintains broken link detection**: Keeps `onBrokenLinks: 'log'` so we 
still catch actual broken documentation links
   2. **No user impact**: Links behave identically from the user's perspective  
   3. **Proper separation**: Respects workspace boundaries - cross-workspace 
navigation uses absolute URLs
   4. **Future-proof**: If workspaces are ever deployed separately, links still 
work
   
   ## Testing
   
   - [ ] Local build: `yarn workspace doc build` (should succeed)
   - [ ] CI build should pass
   - [ ] Verify navbar/footer links work correctly on deployed site
   
   ## Related
   
   - Failed CI run: 
https://github.com/apache/apisix-website/actions/runs/25147485898
   - This issue is unrelated to PR #2034 (April monthly report) which was 
successfully merged


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to