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

Update SDK quickstart pages #1042

Open
3 of 6 tasks
feorlen opened this issue Oct 20, 2023 · 3 comments
Open
3 of 6 tasks

Update SDK quickstart pages #1042

feorlen opened this issue Oct 20, 2023 · 3 comments
Assignees

Comments

@feorlen
Copy link
Collaborator

feorlen commented Oct 20, 2023

Summary

The Go quickstart is several (golang) versions out of date, likely the others have similar issues. Review and update so they work for people with current dev environments.

Intended audience: a developer familiar with the target language but not an experienced MinIO user. For example: the Go quickstart doesn't mention or link to the mc install instructions before using it in a sample command.

Goals

List the in-scope goals

Non-Goals

Converting or adding new step-by-step tutorials usable by novice developers. That should happen in a separate issue.

@feorlen
Copy link
Collaborator Author

feorlen commented Oct 20, 2023

Notes about Go quickstart:

  • go get outside modules was deprecated in 1.17 and removed in 1.18. The replacement is go install. https://golang.org/doc/go-get-install-deprecation issue is you have to be inside a module to run this example anyway
  • Example doesn't mention go mod init or needed dependancies.
  • No mention of needed test file to run the sample code.
  • No link to how to install mc to test the results.

@feorlen
Copy link
Collaborator Author

feorlen commented Oct 25, 2023

Note: C++ doesn't currently have a Quickstart.

@feorlen
Copy link
Collaborator Author

feorlen commented Oct 25, 2023

Note: further improvements via #752

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

1 participant