[jira] [Assigned] (GEODE-10582) Documentation Modernization in the official Apache Geode Document

["Jinwoo Hwang (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/GEODE-10582?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jinwoo Hwang reassigned GEODE-10582:
------------------------------------

    Assignee: Patrick Harmon  (was: ventsislav)

> Documentation Modernization in the official Apache Geode Document
> -----------------------------------------------------------------
>
>                 Key: GEODE-10582
>                 URL: https://issues.apache.org/jira/browse/GEODE-10582
>             Project: Geode
>          Issue Type: Bug
>            Reporter: Jinwoo Hwang
>            Assignee: Patrick Harmon
>            Priority: Major
>
> The Apache Geode GitHub repository (https://github.com/apache/geode) contains documentation with missing or broken image references that impact the user experience and documentation quality.
> *Problem:*
>  * Image links in markdown files are broken or pointing to non-existent resources
>  * Documentation displays broken image placeholders instead of intended diagrams/screenshots
>  * This affects both README files and other documentation across the repository
> *Impact:*
>  * Degrades documentation quality and user experience
>  * Makes it harder for new contributors to understand concepts that rely on visual aids
>  * Affects professional appearance of the project documentation
> *Expected Behavior:*
>  * All images referenced in documentation should display correctly
>  * Image links should point to valid, accessible resources
>  * Documentation should provide clear visual aids where intended
> *Actual Behavior:*
>  * Images appear as broken links or missing placeholders
>  * Some image references point to non-existent files or URLs
> *Suggested Resolution:*
>  # Audit all markdown files in the repository for image references
>  # Identify broken or missing images
>  # Either:
>  ** Fix the image paths to point to correct locations
>  ** Remove broken image references and update documentation accordingly
>  ** Add missing images to appropriate locations in the repository
> *Files/Areas Likely Affected:*
>  * README.md files
>  * Documentation in geode-docs directory
>  * Contributing guidelines
>  * Architecture diagrams
>  * Setup/installation guides
> *Acceptance Criteria:*
>  *  All image references in documentation display correctly
>  *  No broken image links remain in the repository
>  *  Documentation maintains its intended visual clarity



--
This message was sent by Atlassian Jira
(v8.20.10#820010)