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

Consider refactor several spec docs to "example first"? #121

Closed
resouer opened this issue Sep 3, 2019 · 0 comments · Fixed by #190
Closed

Consider refactor several spec docs to "example first"? #121

resouer opened this issue Sep 3, 2019 · 0 comments · Fixed by #190

Comments

@resouer
Copy link
Member

resouer commented Sep 3, 2019

Currently the narrative in hydra spec doc 3,4,5,6 are following Schematics, Representation and then Examples order, while the first two parts are super long.

I feel like new users (OK, I mean myself) tend to drop in lots of details from the very beginning and this lasts all the way to the end until they see some concrete examples.

I am thinking maybe we want to refactor them to "example first"? For example: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/

Another option is, we could create another directory in spec repo for more user faced docs/guides and ref the existing doc when needed, also, we may want to advocate the user faced docs in first place and keep existing docs as references then.

/cc @technosophos @vturecek any thoughts?

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

Successfully merging a pull request may close this issue.

1 participant