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

Left menu on Docs page does not display text as specified #359

Closed
Bi0T1N opened this issue Apr 27, 2023 · 3 comments
Closed

Left menu on Docs page does not display text as specified #359

Bi0T1N opened this issue Apr 27, 2023 · 3 comments
Labels
bug Something isn't working help wanted Extra attention is needed

Comments

@Bi0T1N
Copy link
Contributor

Bi0T1N commented Apr 27, 2023

Description

  • Expected behavior: Menu entry should be ROS/Gazebo Installation
  • Actual behavior: Menu entry is Ros/gazebo Installation

Steps to reproduce

  1. Go to https://gazebosim.org/docs
  2. Notice that the left menu shows "Ros/gazebo Installation"
  3. Compare with what is written in index.yaml
@Bi0T1N Bi0T1N added the bug Something isn't working label Apr 27, 2023
@Bi0T1N Bi0T1N changed the title Left menu on Docs page shows "Ros/gazebo Installation" instead of "ROS/Gazebo Installation" Left menu on Docs page does not display text as specified Apr 27, 2023
@Bi0T1N
Copy link
Contributor Author

Bi0T1N commented Apr 27, 2023

It's not just the single page listed above, it's wrong for all entries with more than one word. To give some more examples:

  • Ros 2 Integration instead of ROS 2 Integration
  • Spawn Urdf instead of Spawn URDF
  • Understanding The Gui instead of Understanding the GUI

It uses its own mechanism for capitalization of the output instead of respecting what is defined in the index.yaml file.

@azeey azeey added the help wanted Extra attention is needed label May 1, 2023
@Bi0T1N
Copy link
Contributor Author

Bi0T1N commented May 6, 2023

I'm not an expert in Golang but the casing might come from the strings.Title() function. It's not used directly in gazebosim-web-backend or gz-go but within the go-gorm dependency.
At least the following examples show the same phenomenon that can be observed at the moment:

package main

import (
	"fmt"
	"strings"
)

func main() {
	fmt.Println(strings.Title(strings.ToLower("Migration from Ignition"))) // Migration From Ignition
	fmt.Println(strings.Title(strings.ToLower("Spawn URDF"))) // Spawn Urdf
	fmt.Println(strings.Title(strings.ToLower("Understanding the GUI"))) // Understanding The Gui
}

@azeey azeey moved this to To do in Core development Jul 24, 2023
@azeey
Copy link
Contributor

azeey commented Jul 18, 2024

Fixed by #441

@azeey azeey closed this as completed Jul 18, 2024
@github-project-automation github-project-automation bot moved this from To do to Done in Core development Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed
Projects
Archived in project
Development

No branches or pull requests

2 participants