Nothing Special   »   [go: up one dir, main page]
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.

Sign up for GitHub

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

Jump to bottom

More documentation needed #360

Open
autarch opened this issue Sep 13, 2018 · 1 comment
Open

More documentation needed #360

autarch opened this issue Sep 13, 2018 · 1 comment

Comments

@autarch
Copy link
autarch commented Sep 13, 2018

I'm trying to read through the v1 example scheduler but it's very difficult to follow. It calls a lot of APIs that are barely documented. Even when a func is documented it's usually just a very minimal description of what it does.

What's missing is any context. I have no idea why any of these calls are important, nor do I have any clue of how this all fits together.

What I'd like to see is much more detailed documentation that explains both what a func does and why I would use it, along with references to how it fits in with other parts of the API.

Now I'm sure patches are welcome but I'm really not in a position to offer one. I don't see how anyone could do this without extremely intimate knowledge of the code base.
@jdef
Copy link
Contributor
jdef commented Feb 13, 2019

Thanks for the feedback. mesos-go assumes that the reader already has some familiarity w/ Mesos and how to interact w/ Mesos using the v1 APIs. The examples aren't really crafted in the spirit of a guided tutorial, but instead as a way to bootstrap framework development. So your feedback makes sense: the examples aren't trying to solve the problem that you seem to be asking for help with.

FWIW the canonical Mesos v1 API references are here:

There's some documentation on the Mesos site to help those interested in building frameworks, e.g. http://mesos.apache.org/documentation/latest/app-framework-development-guide/.

There's at least one book dedicated to Mesos concepts and how to get started building frameworks: http://shop.oreilly.com/product/0636920039952.do

That said, let's keep this ticket open since I do agree that more documentation would be helpful to newcomers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@autarch @jdef