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

[docs] Add diagram to "Lifecycle methods" section #419

Open
Ginden opened this issue Oct 28, 2020 · 8 comments
Open

[docs] Add diagram to "Lifecycle methods" section #419

Ginden opened this issue Oct 28, 2020 · 8 comments
Labels
documentation Non-code related changes

Comments

@Ginden
Copy link

Ginden commented Oct 28, 2020

Support plan

Community

  • is this issue currently blocking your project? (yes/no): no
  • is this issue affecting a production system? (yes/no): no

Context

  • node version: irrelevant
  • module version: 20
  • environment (e.g. node, browser, native): irrelevant
  • used with (e.g. hapi application, another framework, standalone, ...): irrelevant
  • any other relevant information: irrelevant

What problem are you trying to solve?

Detailed description of request lifecycle is rather complicated and it's hard to track flow.

Do you have a new or modified API suggestion to solve the problem?

Add flow diagram explaining request lifecycle.

@Ginden Ginden changed the title [docs]] Add diagram to "Lifecycle methods" section [docs] Add diagram to "Lifecycle methods" section Oct 28, 2020
@YoannMa
Copy link

YoannMa commented Oct 28, 2020

I'm always referring to this diagram https://futurestud.io/downloads/hapi/request-lifecycle when people ask about hapi's request lifecycle

It might not be up to date thought

@Nargonath
Copy link
Member

Thanks for the suggestion @Ginden. This is more related to our documentation website hapi.dev rather than the hapi framework itself. I'll transfer it to the appropriate repository.

@Nargonath Nargonath transferred this issue from hapijs/hapi Oct 30, 2020
@Nargonath Nargonath added the documentation Non-code related changes label Oct 30, 2020
@lloydbenson
Copy link
Contributor

I pinged marcus on slack to see what we can do there.

@lloydbenson lloydbenson self-assigned this Nov 2, 2020
@lloydbenson
Copy link
Contributor

I did finally get a hold of @marcuspoehls and he is now aware of this community ask. He is going to look into seeing what we can do there and how he can help. Initial ideas are just coming up with a new diagram and ideally doing the source too so the community can also help manage it if there are changes / improvements. I am going to reassign this to @marcuspoehls just so its clear its pending more from him.

@lloydbenson lloydbenson removed their assignment Nov 4, 2020
@lloydbenson
Copy link
Contributor

I guess I can't do that, so I'll just leave this unassigned for now.

@Nargonath
Copy link
Member

Also I don't know if you're aware of this repo but we have: https://github.com/hapijs/assets. We could either host that diagram over there or in the hapi.dev repo.

@marcuspoehls
Copy link

@Nargonath @lloydbenson Hey Lloyd, Hey Jonas, thank you for your patience. Let’s approach the lifecycle diagram handover again 😃

I created the lifecycle as a Pages document. Jonas, can I send it to you via email and you’re going to distribute it on the appropriate channels?

@Nargonath
Copy link
Member

Hey @marcuspoehls no problem. "Pages" is a OSX format isn't it? I'm on Windows, I don't know if I'll be able to open it. Anyway you can send it to me and I'll see to convert it in another format somehow. Thank you. 🙏

I'll send you the email via Slack.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Non-code related changes
Projects
None yet
Development

No branches or pull requests

5 participants