[
https://issues.apache.org/jira/browse/GEODE-10489?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jinwoo Hwang updated GEODE-10489:
---------------------------------
Description:
The Apache Geode website contains broken links that are pointing to version
1.16 documentation that may not exist or have been moved. This affects user
experience and documentation accessibility.
h3. Problem
Users encountering broken links when trying to access version 1.16
documentation from the user guide, resulting in 404 errors or incorrect page
redirects.
h3. Impact
* Poor user experience when navigating documentation
* Potential loss of users due to broken navigation
* SEO impact from broken internal links
* Confusion about available documentation versions
h3. Tasks
h4. 1. Identify Broken Links
* Audit the user guide for all references to version 1.16 documentation
* Check links in docs section that may point to non-existent 1.16 paths
* Verify version navigation elements and dropdowns
* Test all internal cross-references and relative links
h4. 2. Determine Root Cause
* Check if version 1.16 documentation was ever published
* Verify if documentation was moved or restructured
* Review git history for any changes affecting version 1.16 links
* Compare with other version documentation structure
h4. 3. Fix Broken Links
* Update links to point to correct documentation versions
* If 1.16 docs don't exist, redirect to nearest available version
* Update navigation menus to reflect available versions
* Fix any hardcoded version references in templates
h4. 4. Update Version Management
* Review version listing logic in the website
* Ensure proper handling of missing version documentation
* Update any automated link generation to handle missing versions
* Add fallback mechanisms for unavailable version links
h3. Files Likely to be Affected:
*
[docs|vscode-file://vscode-app/Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/code/electron-browser/workbench/workbench.html]
directory structure
* Navigation templates and includes
* Version dropdown menus
* User guide content files
* Any automated link generation scripts
h3. Specific Areas to Check:
* Main navigation bar version links
* Documentation index pages
* Cross-references between documentation sections
* Download and release pages that may reference 1.16
* Getting started guides with version-specific instructions
h3. Acceptance Criteria:
* All broken links to version 1.16 documentation are identified and cataloged
* Broken links are either fixed to point to correct locations or removed
* Users can navigate the documentation without encountering 404 errors
* Version navigation works correctly and only shows available versions
* Fallback behavior is implemented for missing version documentation
* Link validation passes for all internal documentation links
h3. Testing Requirements:
* Run comprehensive link checker on entire website
* Manual testing of all version navigation elements
* Cross-browser testing of documentation navigation
* Mobile responsiveness testing for navigation menus
* Verify search functionality still works with updated links
h3. References:
* Current website: https://geode.apache.org
* Documentation section: https://geode.apache.org/docs/
* Available releases: https://geode.apache.org/releases/
h3. Dependencies:
* Access to geode-site repository
* Understanding of the documentation build and publishing process
* List of officially released and documented versions
* Web analytics data to understand impact of broken links
h3. Priority:
High - Broken links significantly impact user experience and should be resolved
quickly.
h3. Labels:
* website
* documentation
* bug
* user-experience
* broken-links
h3. Notes:
This issue may be related to incomplete documentation publishing for version
1.16 or changes in the documentation structure. Consider implementing automated
link validation in the CI/CD process to prevent similar issues in the future.
was:
The Apache Geode website contains broken links that are pointing to version
1.16 documentation that may not exist or have been moved. This affects user
experience and documentation accessibility.
h3. Problem
Users encountering broken links when trying to access version 1.16
documentation from the user guide, resulting in 404 errors or incorrect page
redirects.
h3. Impact
* Poor user experience when navigating documentation
* Potential loss of users due to broken navigation
* SEO impact from broken internal links
* Confusion about available documentation versions
h3. Tasks
h4. 1. Identify Broken Links
* Audit the user guide for all references to version 1.16 documentation
* Check links in docs section that may point to non-existent 1.16 paths
* Verify version navigation elements and dropdowns
* Test all internal cross-references and relative links
h4. 2. Determine Root Cause
* Check if version 1.16 documentation was ever published
* Verify if documentation was moved or restructured
* Review git history for any changes affecting version 1.16 links
* Compare with other version documentation structure
h4. 3. Fix Broken Links
* Update links to point to correct documentation versions
* If 1.16 docs don't exist, redirect to nearest available version
* Update navigation menus to reflect available versions
* Fix any hardcoded version references in templates
h4. 4. Update Version Management
* Review version listing logic in the website
* Ensure proper handling of missing version documentation
* Update any automated link generation to handle missing versions
* Add fallback mechanisms for unavailable version links
h3. Files Likely to be Affected:
*
[docs|vscode-file://vscode-app/Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/code/electron-browser/workbench/workbench.html]
directory structure
* Navigation templates and includes
* Version dropdown menus
* User guide content files
* Any automated link generation scripts
h3. Specific Areas to Check:
* Main navigation bar version links
* Documentation index pages
* Cross-references between documentation sections
* Download and release pages that may reference 1.16
* Getting started guides with version-specific instructions
h3. Acceptance Criteria:
* All broken links to version 1.16 documentation are identified and cataloged
* Broken links are either fixed to point to correct locations or removed
* Users can navigate the documentation without encountering 404 errors
* Version navigation works correctly and only shows available versions
* Fallback behavior is implemented for missing version documentation
* Link validation passes for all internal documentation links
h3. Testing Requirements:
* Run comprehensive link checker on entire website
* Manual testing of all version navigation elements
* Cross-browser testing of documentation navigation
* Mobile responsiveness testing for navigation menus
* Verify search functionality still works with updated links
h3. References:
* Current website:
[https://geode.apache.org|vscode-file://vscode-app/Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/code/electron-browser/workbench/workbench.html]
* Documentation section:
[https://geode.apache.org/docs/|vscode-file://vscode-app/Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/code/electron-browser/workbench/workbench.html]
* Available releases:
[https://geode.apache.org/releases/|vscode-file://vscode-app/Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/code/electron-browser/workbench/workbench.html]
h3. Dependencies:
* Access to geode-site repository
* Understanding of the documentation build and publishing process
* List of officially released and documented versions
* Web analytics data to understand impact of broken links
h3. Priority:
High - Broken links significantly impact user experience and should be resolved
quickly.
h3. Labels:
* website
* documentation
* bug
* user-experience
* broken-links
h3. Notes:
This issue may be related to incomplete documentation publishing for version
1.16 or changes in the documentation structure. Consider implementing automated
link validation in the CI/CD process to prevent similar issues in the future.
> Fix broken link in user guide pointing to version 1.16 documentation
> --------------------------------------------------------------------
>
> Key: GEODE-10489
> URL: https://issues.apache.org/jira/browse/GEODE-10489
> Project: Geode
> Issue Type: Bug
> Reporter: Jinwoo Hwang
> Assignee: Kaajal
> Priority: Major
>
> The Apache Geode website contains broken links that are pointing to version
> 1.16 documentation that may not exist or have been moved. This affects user
> experience and documentation accessibility.
> h3. Problem
> Users encountering broken links when trying to access version 1.16
> documentation from the user guide, resulting in 404 errors or incorrect page
> redirects.
> h3. Impact
> * Poor user experience when navigating documentation
> * Potential loss of users due to broken navigation
> * SEO impact from broken internal links
> * Confusion about available documentation versions
> h3. Tasks
> h4. 1. Identify Broken Links
> * Audit the user guide for all references to version 1.16 documentation
> * Check links in docs section that may point to non-existent 1.16 paths
> * Verify version navigation elements and dropdowns
> * Test all internal cross-references and relative links
> h4. 2. Determine Root Cause
> * Check if version 1.16 documentation was ever published
> * Verify if documentation was moved or restructured
> * Review git history for any changes affecting version 1.16 links
> * Compare with other version documentation structure
> h4. 3. Fix Broken Links
> * Update links to point to correct documentation versions
> * If 1.16 docs don't exist, redirect to nearest available version
> * Update navigation menus to reflect available versions
> * Fix any hardcoded version references in templates
> h4. 4. Update Version Management
> * Review version listing logic in the website
> * Ensure proper handling of missing version documentation
> * Update any automated link generation to handle missing versions
> * Add fallback mechanisms for unavailable version links
> h3. Files Likely to be Affected:
> *
> [docs|vscode-file://vscode-app/Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/code/electron-browser/workbench/workbench.html]
> directory structure
> * Navigation templates and includes
> * Version dropdown menus
> * User guide content files
> * Any automated link generation scripts
> h3. Specific Areas to Check:
> * Main navigation bar version links
> * Documentation index pages
> * Cross-references between documentation sections
> * Download and release pages that may reference 1.16
> * Getting started guides with version-specific instructions
> h3. Acceptance Criteria:
> * All broken links to version 1.16 documentation are identified and
> cataloged
> * Broken links are either fixed to point to correct locations or removed
> * Users can navigate the documentation without encountering 404 errors
> * Version navigation works correctly and only shows available versions
> * Fallback behavior is implemented for missing version documentation
> * Link validation passes for all internal documentation links
> h3. Testing Requirements:
> * Run comprehensive link checker on entire website
> * Manual testing of all version navigation elements
> * Cross-browser testing of documentation navigation
> * Mobile responsiveness testing for navigation menus
> * Verify search functionality still works with updated links
> h3. References:
> * Current website: https://geode.apache.org
> * Documentation section: https://geode.apache.org/docs/
> * Available releases: https://geode.apache.org/releases/
> h3. Dependencies:
> * Access to geode-site repository
> * Understanding of the documentation build and publishing process
> * List of officially released and documented versions
> * Web analytics data to understand impact of broken links
> h3. Priority:
> High - Broken links significantly impact user experience and should be
> resolved quickly.
> h3. Labels:
> * website
> * documentation
> * bug
> * user-experience
> * broken-links
> h3. Notes:
> This issue may be related to incomplete documentation publishing for version
> 1.16 or changes in the documentation structure. Consider implementing
> automated link validation in the CI/CD process to prevent similar issues in
> the future.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
