[docs] Add diagram to "Lifecycle methods" section

hapijs / hapi.dev

The hapi.dev developer portal

53 stars 68 forks source link

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

Open Ginden opened 3 years ago

Ginden commented 3 years ago

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.

YoannMa commented 3 years ago

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 commented 3 years ago

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.

lloydbenson commented 3 years ago

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

lloydbenson commented 3 years ago

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 commented 3 years ago

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

Nargonath commented 3 years ago

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 commented 3 years ago

@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 commented 3 years ago

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.