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

doc: update usages for v1.1 #111

Merged
merged 3 commits into from
Apr 10, 2022
Merged

doc: update usages for v1.1 #111

merged 3 commits into from
Apr 10, 2022

Conversation

Bobgy
Copy link
Collaborator

@Bobgy Bobgy commented Feb 28, 2022

Fixes #103
Fixes #109

README.md Outdated Show resolved Hide resolved
@Bobgy Bobgy changed the title doc: update usages README.md doc: update usages README.md and add README-v2.md Mar 1, 2022
@Bobgy Bobgy changed the title doc: update usages README.md and add README-v2.md doc: update v1 usages and add README-v2.md Mar 1, 2022
@Bobgy Bobgy requested a review from wlynch March 1, 2022 01:56
Copy link
Contributor

@wlynch wlynch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I've been bad about staying on top of this for other PRs, but please squash before submission 🙏

Copy link
Contributor

@wlynch wlynch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I'm not sure if we want to have "v2" docs now that we're tracking in the main branch. 🤔

This refers to a version that doesn't technically exist. Let's aim to keep the main README up to date with the current HEAD? We can always maintain versioned docs through release branches.

@Bobgy
Copy link
Collaborator Author

Bobgy commented Mar 2, 2022

Actually, I'm not sure if we want to have "v2" docs now that we're tracking in the main branch. 🤔

This refers to a version that doesn't technically exist. Let's aim to keep the main README up to date with the current HEAD? We can always maintain versioned docs through release branches.

I'm not sure we want to keep README up to date with the HEAD, because HEAD remains to be the major user facing entrance for documentation. When people visit github.com/google/go-licenses, they immediately see what's in master branch.

I think we can only update default README after maybe a beta release of v2.

For now, I'm proposing this PR -- add a link to point people to the v2 README if they want to try it early and fully fork v2 README to a different file.

@Bobgy
Copy link
Collaborator Author

Bobgy commented Mar 2, 2022

LGTM! I've been bad about staying on top of this for other PRs, but please squash before submission 🙏

The convention I used was that PRs can have multiple commits, but when it's merged in github -- the merge button has an option to squash its commits. I think that approach is preferred because keeping multiple commits in the PR makes it easier to review.

@Bobgy Bobgy force-pushed the update-1.0-readme branch 2 times, most recently from 1ed7ad2 to a7103d5 Compare March 12, 2022 02:34
@Bobgy Bobgy changed the title doc: update v1 usages and add README-v2.md doc: update README.md for v1.1 Mar 12, 2022
@Bobgy
Copy link
Collaborator Author

Bobgy commented Mar 12, 2022

Hi @wlynch, I updated to target this as README of v1.1 release instead.

@Bobgy Bobgy changed the title doc: update README.md for v1.1 doc: update usages for v1.1 Mar 12, 2022
Comment on lines +36 to +37
If you were using `go get` to install this tool, note that
[starting in Go 1.17, go get is deprecated for installing binaries](https://go.dev/doc/go-get-install-deprecation).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note, required features for go install are usable starting from go 1.16, so we can simply tell people to use go install now.

@Bobgy
Copy link
Collaborator Author

Bobgy commented Apr 10, 2022

The doc addresses a lot of user confusions raised in previous issues. I'll merge and release v1.1

@Bobgy Bobgy merged commit e6efe14 into google:master Apr 10, 2022
@Bobgy Bobgy deleted the update-1.0-readme branch April 10, 2022 06:26
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

Successfully merging this pull request may close these issues.

.: -: no Go files Wrong docs for installing the tool
2 participants