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

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

Closed
crandmck opened this issue Sep 26, 2017 · 8 comments
Closed

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

crandmck opened this issue Sep 26, 2017 · 8 comments
Assignees
Labels

Comments

@crandmck
Copy link
Contributor

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

@crandmck crandmck self-assigned this Sep 26, 2017
@loay
Copy link
Contributor

loay commented Sep 29, 2017

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

@crandmck
Copy link
Contributor Author

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

@crandmck
Copy link
Contributor Author

crandmck commented Oct 18, 2017

@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:

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

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
Copy link

VMois commented Oct 18, 2017

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

@loay
Copy link
Contributor

loay commented Oct 19, 2017

@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
Copy link
Contributor Author

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

@crandmck
Copy link
Contributor Author

crandmck commented Oct 26, 2017

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:

  • Part 1: I plan to add a bit more on TypeScript and OpenAPI, since these are really important and what's there now is minimal.
  • Part 2:
    • I added example output from the example code in standard JS callbacks section; but we need to explain what happens in the example and what conclusion(s) you can draw. Need engineering help here.
    • Need to compare and contrast the four approaches in the Comparison section. Could use some input here, too.
  • Part 3:
    • Would like someone to do a technical review of this material. Loay said it looked OK, but I would like confirmation.
    • Ideally, there would be some linkage between what's covered here and parts 1 & 2.
    • Need some help to add material at the end in Putting it all together that explains how Controllers and the API specs, Components & providers, and Sequences all play together; and then try to summarize the whole 3-part series.

@crandmck crandmck added the doc label Nov 1, 2017
@crandmck
Copy link
Contributor Author

crandmck commented Nov 7, 2017

@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.

@crandmck crandmck assigned dhmlau and unassigned crandmck Nov 7, 2017
@dhmlau dhmlau closed this as completed Mar 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants