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 to DevOps guide is broken #1933

Closed
sikai00 opened this issue Mar 7, 2023 · 2 comments · Fixed by #2107
Closed

Link to DevOps guide is broken #1933

sikai00 opened this issue Mar 7, 2023 · 2 comments · Fixed by #2107
Assignees

Comments

@sikai00
Copy link
Member

sikai00 commented Mar 7, 2023

What problem(s) did you run into that caused you to request additional documentation? What, if any, existing documentation relates to this proposal?

  1. Under the DevOps section in the developer guide, the link to DevOps guide leads a Wiki link instead of redirecting to the DevOps guide on the actual Reposense website.
  2. This is likely due to [#1493] DevOps Guide: move from Wiki to DG #1548, where the DevOps guide was shifted from Wiki to DG but the learning basics page itself was not updated.

What would you like added or modified in the documentation?

  1. Fix the broken link
  2. If possible, look through the entire Reposense documentation for any other possible broken links.
@yhtMinceraft1010X
Copy link
Contributor

yhtMinceraft1010X commented Mar 14, 2023

I disagree with the use of the FirstTimers label. While first timer tasks should not be too daunting, I believe they shouldn't be too simple (changing a single link) to the point where the contributor doesn't learn much.

Additionally, to check for links that lead to wrong sites (particularly sites that give 200 OK but are not the intended sites) in all our documentation is quite daunting. A first timer is unlikely to have enough experience with developing RepoSense to know exactly which link should lead to where.

@sikai00
Copy link
Member Author

sikai00 commented Mar 14, 2023

I see, removed the First Timers tag. My initial thought to do so was in consideration of those who had never made any PRs, etc.

@supermii2 supermii2 self-assigned this Feb 2, 2024
ckcherry23 pushed a commit that referenced this issue Feb 11, 2024
Fix broken link to DevOps Guide in Learning Basics page.

Under the DevOps section in the developer guide,
the link to DevOps guide leads a Wiki link instead of redirecting to
the DevOps guide on the actual Reposense website.

Let's fix the broken link by changing the address to the correct page.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Closed/Completed
Development

Successfully merging a pull request may close this issue.

4 participants