Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link Rendering Issues and Typographical Error in Spring Cloud OpenFeign Documentation (v4.2.0) #1143

Closed
limehee opened this issue Jan 7, 2025 · 2 comments
Assignees

Comments

@limehee
Copy link

limehee commented Jan 7, 2025

Describe the bug
When viewing the documentation for Spring Cloud OpenFeign v4.2.0 on Spring Cloud OpenFeign, the following issues with link rendering and typographical errors have been observed:

  1. Link Rendering Issue:
    Inline link texts are not rendered correctly. For example, the text "OpenFeign" is displayed as https://github.com/OpenFeign/feign[OpenFeign] instead of the expected clickable link or plain text "OpenFeign".

  2. Incorrect Link Behavior:
    Under the "Community Support" section, the first bullet point:

You can report issues through https://github.com/spring-cloud/spring-cloud-openfeign/issues[Github].

incorrectly links to https://github.com/spring-cloud/spring-cloud-openfeign/issues%5BGithub%5D instead of https://github.com/spring-cloud/spring-cloud-openfeign/issues. The rendered HTML appears as:

<a href="https://github.com/spring-cloud/spring-cloud-openfeign/issues%5BGithub%5D">https://github.com/spring-cloud/spring-cloud-openfeign/issues[Github]</a>

This behavior leads to broken links and inconsistent text formatting in the documentation.

  1. Typographical Error:
    The term "Github" is used in multiple places within the documentation. The correct spelling is "GitHub" (capitalized "H"). For example, in the bullet point:
You can report issues through https://github.com/spring-cloud/spring-cloud-openfeign/issues[Github].

The term "Github" should be updated to "GitHub" to align with the official spelling.

Sample
Steps to reproduce the issue:

  1. Visit the Spring Cloud OpenFeign documentation.
  2. Inspect the links under the "Community Support" section or the inline mention of "OpenFeign".
  3. Observe the broken link formatting, incorrect URL behavior, and the typographical error in "Github".

Expected Behavior

  1. Inline texts such as OpenFeign should render as proper links (e.g., OpenFeign).
  2. The link in the "Community Support" section should point to the correct URL: https://github.com/spring-cloud/spring-cloud-openfeign/issues.
  3. The term "Github" should be updated to "GitHub" in all occurrences within the documentation.

Environment

  • Version: Spring Cloud OpenFeign v4.2.0
  • Documentation URL: Spring Cloud OpenFeign
  • Browsers Tested: Chrome, Safari
@OlgaMaciaszek
Copy link
Collaborator

Thanks @limehee. I was able to confirm the issue. Will fix now.

@OlgaMaciaszek OlgaMaciaszek moved this to In Progress in 2023.0.5 Jan 8, 2025
@OlgaMaciaszek OlgaMaciaszek moved this from In Progress to Done in 2023.0.5 Jan 8, 2025
@OlgaMaciaszek OlgaMaciaszek closed this as completed by moving to Done in 2023.0.5 Jan 8, 2025
@OlgaMaciaszek OlgaMaciaszek moved this to Done in 2024.0.1 Jan 8, 2025
@OlgaMaciaszek
Copy link
Collaborator

Fixed with https://github.com/spring-io/spring-website-content/pull/153.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Status: Done
Development

No branches or pull requests

3 participants