loopbackio / loopback-next

LoopBack makes it easy to build modern API applications that require complex integrations.
https://loopback.io
Other
4.96k stars 1.07k forks source link

Convert 'Intro to LB4 Dev' article into blogs #589

Closed crandmck closed 6 years ago

crandmck commented 7 years ago

Rand will edit / rewrite / re-organize Intro to LB 4 development into one or more blog posts to help promote LB-Next beta release.

loay commented 7 years ago

@crandmck Hi Rand, I will be able to help out.

crandmck commented 7 years ago

Thanks @loay! I'm going to start working on it soon. I'll ping you when I need your help/input...

crandmck commented 7 years ago

@loay What I have so far is in the strongloop.com lb4-dev-blog branch: https://github.com/strongloop/strongloop.com/blob/lb4-dev-blog/_posts/2017-11-01-intro-to-lb4-for-developers.md

If you want to run Jekyll locally so you can see how it looks, follow the instructions in https://github.com/strongloop/strongloop.com#running-and-viewing-site-locally. I can help if you have problems.

I added a TOC at top of the blog ot help us organize the material... we should remove it before we publish.

My assumption is that we are going to make this into several posts, so the first thing we need to resolve is how we're going to divide up the content. What probably makes most sense is:

What do you think? Is that the right division? Is there enough "meat" for each of those 3 posts? Perhaps we should combine Post 1 and Post 2 above into one post?

Do we need to add more? At a minimum, we'll want to add a "Summary" or "Takeaways" section at the end of each post (including a note about the future upcoming posts), as well as a link to previous post(s) in posts 2 & 3.

Can you please do a technical review of this content; it looks OK to me, but you may have some input or want to make some changes. Ping me if you want to chat.

VMois commented 7 years ago

Could I also help with a blog? I can help with a review or something else.

loay commented 7 years ago

@crandmck The 3 posts content do make sense to me, however, I think we should seperate the topics of Loopback4 from testing and debugging and have them combined in their own post.

We can do :

Post 1: Intro + Foundation
Post 2: Asynchronous patterns
Post 3: LoopBack 4 
Post4: How to test and validate an API spec + How to debug an API spec

If you do not want to make 4 posts, then your 3 posts split is fine by me. I just thought it would make more sense to regroup testing and debugging in one separate post alone.

I don't think that we need to add more, however, we will probably need to add What's Next in the last post to explain to the community what will be the next steps.

I am half way through the technical review.. I will do another comment for the technical review.

Looks Great. Good job.

crandmck commented 7 years ago

Thanks very much @VMois. You're welcome to provide feedback on this blog, or propose your own (in a new issue).

crandmck commented 7 years ago

I considered Loay's suggestion, but the "How to test and validate an API spec + How to debug an API spec" is not really enough to be a post by itself, so I combined it with the LB4 material. I broke up the content into 3 posts, and I think it works OK.

However, they still need some work to make the whole thing more cohesive. Here's what I suggest. Need some input from @bajtos @raymondfeng @kjdelisle and anyone else:

crandmck commented 6 years ago

@dhmlau @bschrammIBM I finished my work on Part 1. I think it's in fairly good shape.

Part 2 and Part 3 still need work as noted above.