search

stanleytangzh / pe

0 stars 0 forks source link

Broken Links in Developer Guide #2

Open stanleytangzh opened 1 week ago

stanleytangzh commented 1 week ago

Description: Certain links in the DG are broken(Documentation guide, Testing guide, Logging guide Configuration guide, DevOps guide links), causing inconvenience to readers trying to read the different guides.

image.png

image.png

nus-pe-bot commented 4 days ago

Team's Response

Thank you for catching this bug! This is a real issue that is pointed out and we acknowledge it! However, we think this will only cause a minor inconvenience for the reader and furthermore, most of our testing and implementation instructions are given in the DG elsewhere. Additionally, resolving the issue is straightforward and does not involve changes to the product itself, minimizing the overall impact.

Hence, we feel that this bug's severity should be reduced to severity.Low instead of a severity.Medium. We hope you find common ground with us on this! Thank you!

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Broken links in DG

Screenshot 2024-11-15 at 5.24.46 PM.png

Screenshot 2024-11-15 at 5.25.24 PM.png

All above links in the DG are broken. Future developers may face great difficulty in accessing these guides.

[original: nus-cs2103-AY2425S1/pe-interim#2997] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thank you for catching this bug! This is a real issue that is pointed out and we acknowledge it! However, we think this will only cause a minor inconvenience for the reader and furthermore, most of our testing and implementation instructions are given in the DG elsewhere. Additionally, resolving the issue is straightforward and does not involve changes to the product itself, minimizing the overall impact.

Hence, we feel that this bug's severity should be reduced to severity.Low instead of a severity.Medium. We hope you find common ground with us on this! Thank you!

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]