From 6c11f962124e5498ebeb84233463a6ee766ed540 Mon Sep 17 00:00:00 2001 From: Kevin Delisle Date: Fri, 16 Feb 2018 11:45:27 -0500 Subject: [PATCH 1/5] docs(example-getting-started): add links to tutorial paths The README now links back to the pathways for the tutorial, either on our docs site or in this package. #729 --- packages/example-getting-started/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/example-getting-started/README.md b/packages/example-getting-started/README.md index c8eba4a84872..3c381376b97a 100644 --- a/packages/example-getting-started/README.md +++ b/packages/example-getting-started/README.md @@ -1,6 +1,10 @@ # @loopback/example-getting-started This is the basic tutorial for getting started with Loopback 4! +[Click here](https://loopback.io/doc/en/lb4/Getting-started.html) to follow +along, or jump to the +[docs section](https://github.com/strongloop/loopback-next/tree/master/packages/example-getting-started/docs) +and go through the pages in numbered order. ### Stuck? Check out our [Gitter channel](https://gitter.im/strongloop/loopback) and ask From 0135933c0af46839286ea8667667aee69cb2e922 Mon Sep 17 00:00:00 2001 From: Kevin Delisle Date: Tue, 20 Feb 2018 12:09:17 -0500 Subject: [PATCH 2/5] docs(example-getting-started): link docs pages together --- packages/example-getting-started/README.md | 7 +++---- .../docs/1-prerequisites-and-setup.md | 4 ++++ .../example-getting-started/docs/2-scaffold-app.md | 5 +++++ .../docs/3-add-legacy-juggler.md | 6 +++++- .../example-getting-started/docs/4-todo-model.md | 4 ++++ .../example-getting-started/docs/5-datasource.md | 5 +++++ .../example-getting-started/docs/6-repository.md | 4 ++++ .../example-getting-started/docs/7-controller.md | 5 +++++ .../docs/8-putting-it-together.md | 12 ++++++++++++ 9 files changed, 47 insertions(+), 5 deletions(-) diff --git a/packages/example-getting-started/README.md b/packages/example-getting-started/README.md index 3c381376b97a..cc9f1ddb791d 100644 --- a/packages/example-getting-started/README.md +++ b/packages/example-getting-started/README.md @@ -1,10 +1,9 @@ # @loopback/example-getting-started This is the basic tutorial for getting started with Loopback 4! -[Click here](https://loopback.io/doc/en/lb4/Getting-started.html) to follow -along, or jump to the -[docs section](https://github.com/strongloop/loopback-next/tree/master/packages/example-getting-started/docs) -and go through the pages in numbered order. + +To get started, jump into the +[Prerequisites and setup](docs/1-prerequisites-and-setup.html) section. ### Stuck? Check out our [Gitter channel](https://gitter.im/strongloop/loopback) and ask diff --git a/packages/example-getting-started/docs/1-prerequisites-and-setup.md b/packages/example-getting-started/docs/1-prerequisites-and-setup.md index cb75fb59965d..e73f9792da5a 100644 --- a/packages/example-getting-started/docs/1-prerequisites-and-setup.md +++ b/packages/example-getting-started/docs/1-prerequisites-and-setup.md @@ -28,3 +28,7 @@ cd loopback-example-getting-started && npm i ``` npm start ``` + +### Navigation + +Next step: [Scaffolding your application](2-scaffold-app.html) diff --git a/packages/example-getting-started/docs/2-scaffold-app.md b/packages/example-getting-started/docs/2-scaffold-app.md index edb3a160adfc..8b65da385386 100644 --- a/packages/example-getting-started/docs/2-scaffold-app.md +++ b/packages/example-getting-started/docs/2-scaffold-app.md @@ -11,3 +11,8 @@ not to enable certain project features (loopback's build, tslint, mocha, etc.), leave them all enabled. + +### Navigation + +Previous step: [Prerequisites and setup](1-prerequisites-and-setup.html) +Next step: [Adding the legacy juggler](3-add-legacy-juggler.html) diff --git a/packages/example-getting-started/docs/3-add-legacy-juggler.md b/packages/example-getting-started/docs/3-add-legacy-juggler.md index e44d07de19f2..11c4bb5fb5d8 100644 --- a/packages/example-getting-started/docs/3-add-legacy-juggler.md +++ b/packages/example-getting-started/docs/3-add-legacy-juggler.md @@ -1,4 +1,4 @@ -### Adding Legacy Juggler Capabilities +### Adding the Legacy Juggler Jump into the directory for your new application. You'll see a folder structure similar to this: @@ -52,3 +52,7 @@ export class TodoApplication extends RepositoryMixin(RestApplication) { } } ``` +### Navigation + +Previous step: [Scaffolding your application](2-scaffold-app.html) +Next step: [Add your Todo model](4-todo-model.html) diff --git a/packages/example-getting-started/docs/4-todo-model.md b/packages/example-getting-started/docs/4-todo-model.md index 408758a746a7..c1e32be589b7 100644 --- a/packages/example-getting-started/docs/4-todo-model.md +++ b/packages/example-getting-started/docs/4-todo-model.md @@ -102,3 +102,7 @@ export const TodoSchema: SchemaObject = { required: ['title'], }; ``` +### Navigation + +Previous step: [Adding the Legacy Juggler](3-add-legacy-juggler.html) +Next step: [Add a datasource](5-datasource.html) diff --git a/packages/example-getting-started/docs/5-datasource.md b/packages/example-getting-started/docs/5-datasource.md index 9cc2ff210e2a..bc589cdbcd92 100644 --- a/packages/example-getting-started/docs/5-datasource.md +++ b/packages/example-getting-started/docs/5-datasource.md @@ -32,3 +32,8 @@ export const db = new DataSourceConstructor(config); This will give us a strongly-typed datasource export that we can work with to construct our TodoRepository definition. + +### Navigation + +Previous step: [Add your Todo model](4-todo-model.html) +Next step: [Add a repository](6-repository.html) diff --git a/packages/example-getting-started/docs/6-repository.md b/packages/example-getting-started/docs/6-repository.md index b2520590985a..115fc171cd28 100644 --- a/packages/example-getting-started/docs/6-repository.md +++ b/packages/example-getting-started/docs/6-repository.md @@ -26,3 +26,7 @@ export class TodoRepository extends DefaultCrudRepository< } } ``` +### Navigation + +Previous step: [Add a datasource](5-datasource.html) +Next step: [Add a controller](7-controller.html) diff --git a/packages/example-getting-started/docs/7-controller.md b/packages/example-getting-started/docs/7-controller.md index 484cd906b096..93cd398cedae 100644 --- a/packages/example-getting-started/docs/7-controller.md +++ b/packages/example-getting-started/docs/7-controller.md @@ -63,3 +63,8 @@ export class TodoController { } } ``` + +### Navigation + +Previous step: [Add a repository](6-repository.html) +Final step: [Putting it all together](8-putting-it-together.html) diff --git a/packages/example-getting-started/docs/8-putting-it-together.md b/packages/example-getting-started/docs/8-putting-it-together.md index 11bbac64ecfa..2760bc084c54 100644 --- a/packages/example-getting-started/docs/8-putting-it-together.md +++ b/packages/example-getting-started/docs/8-putting-it-together.md @@ -52,3 +52,15 @@ Start the app (`npm start`) and then make some REST requests: - `POST /todo` with a body of `{ "title": "get the milk" }` - `GET /todo/1` and see if you get your Todo object back. - `PATCH /todo/1` with a body of `{ "desc": "need milk for cereal" }` + +### Navigation + +Previous step: [Add a controller](7-controller.html) + +### More examples and tutorials + +Eager to continue learning about LoopBack 4? Check out our +[examples and tutorials](https://loopback.io/doc/en/lb4/Examples-and-tutorials.html) +section to find examples for creating your own custom components, sequences and +more! + From 91e457bacd001a2ff0b539437cfee375920e0d98 Mon Sep 17 00:00:00 2001 From: Kevin Delisle Date: Tue, 20 Feb 2018 12:17:16 -0500 Subject: [PATCH 3/5] docs(example-getting-started): switch to md links --- packages/example-getting-started/README.md | 2 +- .../example-getting-started/docs/1-prerequisites-and-setup.md | 2 +- packages/example-getting-started/docs/2-scaffold-app.md | 4 ++-- packages/example-getting-started/docs/3-add-legacy-juggler.md | 4 ++-- packages/example-getting-started/docs/4-todo-model.md | 4 ++-- packages/example-getting-started/docs/5-datasource.md | 4 ++-- packages/example-getting-started/docs/6-repository.md | 4 ++-- packages/example-getting-started/docs/7-controller.md | 4 ++-- .../example-getting-started/docs/8-putting-it-together.md | 2 +- 9 files changed, 15 insertions(+), 15 deletions(-) diff --git a/packages/example-getting-started/README.md b/packages/example-getting-started/README.md index cc9f1ddb791d..d090b7a9fada 100644 --- a/packages/example-getting-started/README.md +++ b/packages/example-getting-started/README.md @@ -3,7 +3,7 @@ This is the basic tutorial for getting started with Loopback 4! To get started, jump into the -[Prerequisites and setup](docs/1-prerequisites-and-setup.html) section. +[Prerequisites and setup](docs/1-prerequisites-and-setup.md) section. ### Stuck? Check out our [Gitter channel](https://gitter.im/strongloop/loopback) and ask diff --git a/packages/example-getting-started/docs/1-prerequisites-and-setup.md b/packages/example-getting-started/docs/1-prerequisites-and-setup.md index e73f9792da5a..713e5c2a6e2c 100644 --- a/packages/example-getting-started/docs/1-prerequisites-and-setup.md +++ b/packages/example-getting-started/docs/1-prerequisites-and-setup.md @@ -31,4 +31,4 @@ npm start ### Navigation -Next step: [Scaffolding your application](2-scaffold-app.html) +Next step: [Scaffolding your application](2-scaffold-app.md) diff --git a/packages/example-getting-started/docs/2-scaffold-app.md b/packages/example-getting-started/docs/2-scaffold-app.md index 8b65da385386..64730de8124a 100644 --- a/packages/example-getting-started/docs/2-scaffold-app.md +++ b/packages/example-getting-started/docs/2-scaffold-app.md @@ -14,5 +14,5 @@ leave them all enabled. ### Navigation -Previous step: [Prerequisites and setup](1-prerequisites-and-setup.html) -Next step: [Adding the legacy juggler](3-add-legacy-juggler.html) +Previous step: [Prerequisites and setup](1-prerequisites-and-setup.md) +Next step: [Adding the legacy juggler](3-add-legacy-juggler.md) diff --git a/packages/example-getting-started/docs/3-add-legacy-juggler.md b/packages/example-getting-started/docs/3-add-legacy-juggler.md index 11c4bb5fb5d8..2b9c6b6ea73f 100644 --- a/packages/example-getting-started/docs/3-add-legacy-juggler.md +++ b/packages/example-getting-started/docs/3-add-legacy-juggler.md @@ -54,5 +54,5 @@ export class TodoApplication extends RepositoryMixin(RestApplication) { ``` ### Navigation -Previous step: [Scaffolding your application](2-scaffold-app.html) -Next step: [Add your Todo model](4-todo-model.html) +Previous step: [Scaffolding your application](2-scaffold-app.md) +Next step: [Add your Todo model](4-todo-model.md) diff --git a/packages/example-getting-started/docs/4-todo-model.md b/packages/example-getting-started/docs/4-todo-model.md index c1e32be589b7..71d44f6d23bd 100644 --- a/packages/example-getting-started/docs/4-todo-model.md +++ b/packages/example-getting-started/docs/4-todo-model.md @@ -104,5 +104,5 @@ export const TodoSchema: SchemaObject = { ``` ### Navigation -Previous step: [Adding the Legacy Juggler](3-add-legacy-juggler.html) -Next step: [Add a datasource](5-datasource.html) +Previous step: [Adding the Legacy Juggler](3-add-legacy-juggler.md) +Next step: [Add a datasource](5-datasource.md) diff --git a/packages/example-getting-started/docs/5-datasource.md b/packages/example-getting-started/docs/5-datasource.md index bc589cdbcd92..7d8aa6066902 100644 --- a/packages/example-getting-started/docs/5-datasource.md +++ b/packages/example-getting-started/docs/5-datasource.md @@ -35,5 +35,5 @@ construct our TodoRepository definition. ### Navigation -Previous step: [Add your Todo model](4-todo-model.html) -Next step: [Add a repository](6-repository.html) +Previous step: [Add your Todo model](4-todo-model.md) +Next step: [Add a repository](6-repository.md) diff --git a/packages/example-getting-started/docs/6-repository.md b/packages/example-getting-started/docs/6-repository.md index 115fc171cd28..fcd089ccb497 100644 --- a/packages/example-getting-started/docs/6-repository.md +++ b/packages/example-getting-started/docs/6-repository.md @@ -28,5 +28,5 @@ export class TodoRepository extends DefaultCrudRepository< ``` ### Navigation -Previous step: [Add a datasource](5-datasource.html) -Next step: [Add a controller](7-controller.html) +Previous step: [Add a datasource](5-datasource.md) +Next step: [Add a controller](7-controller.md) diff --git a/packages/example-getting-started/docs/7-controller.md b/packages/example-getting-started/docs/7-controller.md index 93cd398cedae..2a314eb833d4 100644 --- a/packages/example-getting-started/docs/7-controller.md +++ b/packages/example-getting-started/docs/7-controller.md @@ -66,5 +66,5 @@ export class TodoController { ### Navigation -Previous step: [Add a repository](6-repository.html) -Final step: [Putting it all together](8-putting-it-together.html) +Previous step: [Add a repository](6-repository.md) +Final step: [Putting it all together](8-putting-it-together.md) diff --git a/packages/example-getting-started/docs/8-putting-it-together.md b/packages/example-getting-started/docs/8-putting-it-together.md index 2760bc084c54..579af3919815 100644 --- a/packages/example-getting-started/docs/8-putting-it-together.md +++ b/packages/example-getting-started/docs/8-putting-it-together.md @@ -55,7 +55,7 @@ Start the app (`npm start`) and then make some REST requests: ### Navigation -Previous step: [Add a controller](7-controller.html) +Previous step: [Add a controller](7-controller.md) ### More examples and tutorials From 3da8339f4adef70346dd2e41243912ed767bf5e5 Mon Sep 17 00:00:00 2001 From: Kevin Delisle Date: Tue, 20 Feb 2018 12:48:59 -0500 Subject: [PATCH 4/5] docs(example-getting-started): add tutorial steps for easy nav --- packages/example-getting-started/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/packages/example-getting-started/README.md b/packages/example-getting-started/README.md index d090b7a9fada..177887461981 100644 --- a/packages/example-getting-started/README.md +++ b/packages/example-getting-started/README.md @@ -5,6 +5,17 @@ This is the basic tutorial for getting started with Loopback 4! To get started, jump into the [Prerequisites and setup](docs/1-prerequisites-and-setup.md) section. +## Tutorial Steps + +1. [Prerequisites and setup](docs/1-prerequisites-and-setup.md) +1. [Scaffolding your application](docs/2-scaffold-app.md) +1. [Adding the legacy juggler](docs/3-add-legacy-juggler.md) +1. [Add your Todo model](docs/4-todo-model.md) +1. [Add a datasource](docs/5-datasource.md) +1. [Add a repository](docs/6-repository.md) +1. [Add a controller](docs/7-controller.md) +1. [Putting it all together](docs/8-putting-it-together.md) + ### Stuck? Check out our [Gitter channel](https://gitter.im/strongloop/loopback) and ask for help with this tutorial! From 35a0812de4079c0fadd447a7d7606ed5dd23e747 Mon Sep 17 00:00:00 2001 From: Kevin Delisle Date: Tue, 20 Feb 2018 12:51:40 -0500 Subject: [PATCH 5/5] fix(example-getting-started): correct spacing on navigation sections --- packages/example-getting-started/docs/2-scaffold-app.md | 1 + packages/example-getting-started/docs/3-add-legacy-juggler.md | 1 + packages/example-getting-started/docs/4-todo-model.md | 1 + packages/example-getting-started/docs/5-datasource.md | 1 + packages/example-getting-started/docs/6-repository.md | 1 + packages/example-getting-started/docs/7-controller.md | 1 + 6 files changed, 6 insertions(+) diff --git a/packages/example-getting-started/docs/2-scaffold-app.md b/packages/example-getting-started/docs/2-scaffold-app.md index 64730de8124a..eefbd82b8013 100644 --- a/packages/example-getting-started/docs/2-scaffold-app.md +++ b/packages/example-getting-started/docs/2-scaffold-app.md @@ -15,4 +15,5 @@ leave them all enabled. ### Navigation Previous step: [Prerequisites and setup](1-prerequisites-and-setup.md) + Next step: [Adding the legacy juggler](3-add-legacy-juggler.md) diff --git a/packages/example-getting-started/docs/3-add-legacy-juggler.md b/packages/example-getting-started/docs/3-add-legacy-juggler.md index 2b9c6b6ea73f..d11d7717b592 100644 --- a/packages/example-getting-started/docs/3-add-legacy-juggler.md +++ b/packages/example-getting-started/docs/3-add-legacy-juggler.md @@ -55,4 +55,5 @@ export class TodoApplication extends RepositoryMixin(RestApplication) { ### Navigation Previous step: [Scaffolding your application](2-scaffold-app.md) + Next step: [Add your Todo model](4-todo-model.md) diff --git a/packages/example-getting-started/docs/4-todo-model.md b/packages/example-getting-started/docs/4-todo-model.md index 71d44f6d23bd..168312ef218d 100644 --- a/packages/example-getting-started/docs/4-todo-model.md +++ b/packages/example-getting-started/docs/4-todo-model.md @@ -105,4 +105,5 @@ export const TodoSchema: SchemaObject = { ### Navigation Previous step: [Adding the Legacy Juggler](3-add-legacy-juggler.md) + Next step: [Add a datasource](5-datasource.md) diff --git a/packages/example-getting-started/docs/5-datasource.md b/packages/example-getting-started/docs/5-datasource.md index 7d8aa6066902..958259971413 100644 --- a/packages/example-getting-started/docs/5-datasource.md +++ b/packages/example-getting-started/docs/5-datasource.md @@ -36,4 +36,5 @@ construct our TodoRepository definition. ### Navigation Previous step: [Add your Todo model](4-todo-model.md) + Next step: [Add a repository](6-repository.md) diff --git a/packages/example-getting-started/docs/6-repository.md b/packages/example-getting-started/docs/6-repository.md index fcd089ccb497..95569abc0935 100644 --- a/packages/example-getting-started/docs/6-repository.md +++ b/packages/example-getting-started/docs/6-repository.md @@ -29,4 +29,5 @@ export class TodoRepository extends DefaultCrudRepository< ### Navigation Previous step: [Add a datasource](5-datasource.md) + Next step: [Add a controller](7-controller.md) diff --git a/packages/example-getting-started/docs/7-controller.md b/packages/example-getting-started/docs/7-controller.md index 2a314eb833d4..96d16354e8aa 100644 --- a/packages/example-getting-started/docs/7-controller.md +++ b/packages/example-getting-started/docs/7-controller.md @@ -67,4 +67,5 @@ export class TodoController { ### Navigation Previous step: [Add a repository](6-repository.md) + Final step: [Putting it all together](8-putting-it-together.md)