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

General structure #4

Open
tpluscode opened this issue Mar 31, 2019 · 2 comments
Open

General structure #4

tpluscode opened this issue Mar 31, 2019 · 2 comments

Comments

@tpluscode
Copy link
Collaborator

Off the top of my head, I just thought that I'd reorganize the cookbook pages in three general categories or angles:

  1. Hydra concepts
    • details of interpreting different structures represented by Hydra Api Doc and resource representations
  2. Implementing the client
    • Slightly overlapping with the above but with emphasis of client behavior rather static analysis
  3. Implementing the server
    • Server's perspective on Hydra requests and behavior

Now, this could be done twofold. Either we have those as top level categories and pages which slightly overlap, or structure individual articles so that the cover all three areas where possible. So that each cookbook article approaches the given subject at 3 angles.

@angelo-v
Copy link
Contributor

angelo-v commented Apr 1, 2019

Seems to be a reasonable struture. From gut feeling I would prefer the latter option having one article with 3 perspectives, but I guess we just should try out.

@alien-mcl
Copy link
Member

I'm not sure. Concepts feels to be redundant with spec. I always look for real meat - examples of specific usages when I want to quickly implement something that works in technology I don't now to well.
That's why I've started from use cases as these carry one important (from my perspective) information:
what can be done with / what you can expect from hydra

Still - showing each use case with various perspectives (client/server) is a go go :)

tpluscode added a commit to tpluscode/hydra-book that referenced this issue Jul 16, 2019
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