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: add screencast to docs #20404

rakyll opened this issue May 18, 2017 · 2 comments

doc: add screencast to docs #20404

rakyll opened this issue May 18, 2017 · 2 comments


Copy link

@rakyll rakyll commented May 18, 2017

This is a tracking bug to add screencasts to the docs.

A brief draft of the content we want to cover with the screencasts, these are not sorted by priority at this moment - please contribute to the discussion of prioritization:

  • Installation
    • Platform dependent
  • Environment set-up
    • Platform dependent
    • GOPATH / src/pkg/bin etc
    • go version
    • go help
  • Writing "Hello, world!"
    • Where does it go?
    • Editors, plugins, etc (link to them)
    • Importing packages in the std lib / How to access documentation?
    • go install/run/build
  • Writing your first library
    • Package names and how to import them
    • Documentation
  • Using non stdlib packages
    • Importing non stdlib packages
    • go get (-u)
  • Testing
    • go test
    • Code coverage
  • Managing your GOPATH
    • go list
    • Folder structure
    • Multiple GOPATHs
  • Managing dependencies
    • Vendoring?
    • Versioning? Semver
  • Contributing to GitHub repos
    • Forks and PRs
  • Contributing to the Go project
    • Set up
    • Gerrit
    • Contributing guidelines
  • Debugging
  • Performance profiling
    • Benchmarks
    • Load testing
    • Pprof
    • Flame Graphs
  • Execution tracer

Constraints on videos:

  • Platform dependent steps should be contained into different video variations
  • Videos should be short (target ~2 minutes, absolute max 5 minutes)
  • Each video should mirror a specific document, to improve cross linking

/cc @campoy @goinggo @jessfraz

Copy link

@ScottMansfield ScottMansfield commented May 18, 2017

How will these be maintained over time?

@rakyll rakyll added the DevExp label May 18, 2017
Copy link
Contributor Author

@rakyll rakyll commented May 18, 2017

Good question. We are keeping things small and brief to make it possible reshoot them. Also, videos are going to be supplementary only. If we cannot update an outdated video, it should be safe to just remove it and depend on the text.

@ianlancetaylor ianlancetaylor added this to the Unplanned milestone Apr 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.