search

josepholim / pe

0 stars 0 forks source link

Inconsistent linking to glossary #16

Open josepholim opened 11 months ago

josepholim commented 11 months ago

In this photo some instances of"Command Line Inreface" are linked to glossary while some others are not. image.png

soc-pe-bot commented 11 months ago

Team's Response

Thank you for the bug report.

some instances of"Command Line Inreface" are linked to glossary

Only the first "Command Line Interface (CLI)" instance in the "Using the Command Line Interface (CLI)" section is linked to the Glossary section. Moreover, in the entire UG, only one instance of "Command Line Interface (CLI)" is linked to the Glossary section.

In the Glossary section, the definition of CLI is provided, and users who wish to know more about the CLI could read its definition there. We believe that it is appropriate to formally introduce the CLI and its definition in a section dedicated to the CLI.

In this photo some instances of"Command Line Inreface" are linked to glossary while some others are not.

It seems like you are suggesting that we do either of the extremes:

  1. Link all "Command Line Interface (CLI)" instances to Glossary, OR
  2. Do not link any "Command Line Interface (CLI)" instances to the Glossary.

We feel that neither would do any good for our readers. By linking all "Command Line Interface (CLI)" instances to Glossary, it would only serve to impede the flow of the UG as users may end up in the same old Glossary section multiple times, reading the same old definition of the CLI. Also, If we look at popular and well-established webpages like Wikipedia, only one instance of a terminology contains a hyperlink. If the same terminology appears again, it probably will not contain a hyperlink.

By removing all links to the Glossary section, we are denying interested and curious readers an opportunity to learn about the definition of CLI.

We could simply leave the definition in the section, right? Well, our target users are School of Computing students, who presumably have lots of experience in CLI in their CS courses. Adding a definition about CLI would not add value for them, and would only serve to clutter our UG and make it less readable for our readers.

We have and always will craft our UG with the readers in mind.

We hope that this justification would allow you to gain some insights into why we have formatted the hyperlinks this way.

Therefore, we are rejecting this bug report.

Thank you.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: When I was stating that some instances of "Command Line Interface" linked to glossary and some others not, I also wanted to get this one into your attention.

image.png

This one links to https://www.w3schools.com/whatis/whatis_cli.asp Which is also an inconsistent linking to glossary.

You might want to change this link to the glossary instead.

For the comparison between not having a link at all and linking to glossary as you said, I agree with what you argued. But there exists one that links to an external website.