docs icon indicating copy to clipboard operation
docs copied to clipboard

Update SDK quickstart pages

Open feorlen opened this issue 2 years ago • 3 comments

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 avatar Oct 20 '23 16:10 feorlen

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 avatar Oct 20 '23 16:10 feorlen

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

feorlen avatar Oct 25 '23 15:10 feorlen

Note: further improvements via https://github.com/minio/docs/issues/752

feorlen avatar Oct 25 '23 17:10 feorlen