-
Notifications
You must be signed in to change notification settings - Fork 2.7k
docs: remove unused go.mod #4115
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
Conversation
docs/go.mod
Outdated
| github.com/imfing/hextra v0.5.0 // indirect | ||
| github.com/thegeeklab/hugo-geekdoc v0.41.2 // indirect | ||
| ) | ||
| go 1.20 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could even remove the version, but looks like go mod tidy wants to add "something" back. Technically "any" version would work, so we could set it to something really low.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense.
|
This is probably just my lack of go experience, but, why do we have a go.mod in the docs package at all when there is no code there? |
|
Perhaps it needs a comment; this is used to facilitate Hugo's feature to vendor documentation from multiple repositories; Hugo has a feature to get documentation "modules" from repositories, and it uses the Go modules logic for that; https://gohugo.io/hugo-modules/ The docker documentation currently uses this to combine docs from multiple sources (see https://github.com/docker/docs/blob/main/go.mod) I guess the added benefit is that vendoring @dvdksn may be able to provide more details if needed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No harm and supports other workflows, so why not.
A comment somewhere would be nice, maybe in the README.md for the docs?
|
@dvdksn would you mind opening a PR that updates the docs that explain this so that whoever picks up some docs related work doesn't have to ask the same questions 😄 |
|
Just checked and the |
|
@thaJeztah do you wanna delete those files as per @dvdksn comment? |
|
Ping @thaJeztah RE: my and @dvdksn's last comments |
This go.mod was used to allow vendoring the docs with Hugo, but this was never used, so we can remove the go.mod altogether. Signed-off-by: Sebastiaan van Stijn <[email protected]>
f7987db to
186d522
Compare
|
whoops, missed your ping; updated and removed the |
Uh oh!
There was an error while loading. Please reload this page.