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

Add/decide on top level sections #4

Open
munnerz opened this issue Jun 15, 2018 · 2 comments
Open

Add/decide on top level sections #4

munnerz opened this issue Jun 15, 2018 · 2 comments

Comments

@munnerz
Copy link
Contributor

munnerz commented Jun 15, 2018

We should decide on the top level sections for the docs.

From brief discussion on Slack:

  • Concepts - describing the various different concepts in controller design

    • level based programming
    • an overview of the various core functions client-go provides
    • a 'map' of client-go, apimachinery, api, code-generator, restclient vs typed client so users understand what is what
    • details on the 'tools' in client-go (i.e. leader election, informers maybe? - this may link out to examples)
    • details on what code-generator does, what each generator is used for, how it works, why it exists
  • Tutorials

    • building a project from scratch
    • generating reference API documentation
    • generating openapi validation schema
    • adding leader election to your controller
  • Contributing

    • how to contribute to these docs

/cc @sttts @lilic @nikhita

@nikhita
Copy link
Member

nikhita commented Jun 15, 2018

From @sttts on slack: http://using-client-go.cloudnative.sh/ by @mhausenblas.

It is a good place to start. 👍

@xmudrii
Copy link
Contributor

xmudrii commented Jun 26, 2018

Potentially good topic could be 'Testing and mocking with client-go', describing how to write unit tests for controllers/API servers, how to create and manage resources from tests, how to mock indexers..

'Vendoring client-go with dep/GoDeps/Glide' may be a good article as well. That one could also cover vendoring code-generators (for dep, this can be useful golang/dep#1306 (comment). Running in a Docker container is an option as well).

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

3 participants