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

(Very) minor improvements to CONTRIBUTING.md #1200

Closed
Kostas-F opened this issue Oct 19, 2023 · 3 comments
Closed

(Very) minor improvements to CONTRIBUTING.md #1200

Kostas-F opened this issue Oct 19, 2023 · 3 comments
Assignees
Milestone

Comments

@Kostas-F
Copy link

Kostas-F commented Oct 19, 2023

Summary

Some minor problems I spotted with the md file that would be quick to fix . All trivial, but sorted in my perceived order of "importance"

https://github.com/TheThingsNetwork/lorawan-stack/blob/v3.28/CONTRIBUTING.md:

  1. Line 5: The link to the forum category is dead. I believe the correct url now is https://www.thethingsnetwork.org/forum/c/ttn-network/v3/90

  2. Line 9: The site referenced as the location of user documentation is thethingstack.io. It properly redirects to the thethingindustries docs location so no problems there. However correcting the user facing link would help with dissambiguiation.

  3. Also Line 9: Missing parenthesis in the docs repository link.

Why do we need this ?

To assist users in finding the reference locations with the least ammount of friction

What is already there? What do you see now? What would you like to see?

The refenced minor issues and their corrections respectively.

@github-actions github-actions bot added the needs/triage We still need to triage this label Oct 19, 2023
@KrishnaIyer KrishnaIyer removed the needs/triage We still need to triage this label Oct 19, 2023
@KrishnaIyer KrishnaIyer added this to the Nov 2023 milestone Oct 19, 2023
@Kostas-F
Copy link
Author

Kostas-F commented Oct 20, 2023

This is in reference to the CONTRIBUTING.md in The Things Network lorawan-stack repository, I just realized the issue opened in this repository (Things Industries) when I clicked the documentation request in the issue dialog. I hope it is not in the wrong place

@nejraselimovic
Copy link
Contributor

Hey @Kostas-F, thanks for reporting, this should've been submitted to TTN and TTI lorawan-stack repos indeed, but never mind, I've submitted PRs to fix this on both places:

https://github.com/TheThingsIndustries/lorawan-stack/pull/3951
TheThingsNetwork/lorawan-stack#6703

@Kostas-F
Copy link
Author

Hi @nejraselimovic I apologize for the confusion, thank you for taking the time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants