docs(example-getting-started): add links to tutorial paths #1012
Conversation
| # @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 |
There was a problem hiding this comment.
I'm assuming the contents in this link are going to change with another PR, since right now it's just creating a simple app using lb app and adding a hello world controller.
There was a problem hiding this comment.
I think the plan is to replace contents of Getting-started with the tutorial from todo app
| # @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 |
There was a problem hiding this comment.
I think the plan is to replace contents of Getting-started with the tutorial from todo app
| 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) |
There was a problem hiding this comment.
It would be much better to embed bullet points of the high-level steps here. For example:
1. [One line description for `prerequisites-and-setup.md`](prerequisites-and-setup.md)
2. scaffold-app.md
3. add-legacy-juggler.md
4. todo-model.md
5. datasource.md
6. repository.md
7. controller.md
8. putting-it-together.md 
There was a problem hiding this comment.
+1 to a list linking to the steps that makes it more eye-catching. I'd just saying that it might be better to write down "Section" / "Step" Names instead of names of the .md files.
There was a problem hiding this comment.
The problem I'm currently having is that if I create links internally, then they'll link back to the GitHub repository from within loopback.io, since this whole file is pulled into the docs page as an include.
raymondfeng
left a comment
raymondfeng
left a comment
There was a problem hiding this comment.
The docs section link does not catch a reader's eye, IMO.
kjdelisle
force-pushed
the
example-getting-started/connect-readme-to-tutorial
branch
from
ecc6a1d to
7fd529c
Compare
The README now links back to the pathways for the tutorial, either on our docs site or in this package. #729
kjdelisle
force-pushed
the
example-getting-started/connect-readme-to-tutorial
branch
from
7fd529c to
0135933
Compare
| 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. |
There was a problem hiding this comment.
Hmm, I think the link should be docs/1-prerequisites-and-setup.md. When it's imported into loopback.io, we probably need to enhance the script to change from .md to .html.
There was a problem hiding this comment.
I also prefer to list all sub tutorials here. I understand 1-prerequisites-and-setup.md has navigation to other ones but having all of them visible at top README level allows users to preview and jump.
| 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) |
There was a problem hiding this comment.
Interesting to use 1. for all items :-). Personally I prefer to number them.
There was a problem hiding this comment.
Mostly simplifies copy/paste/reordering in the future. Most parsers automatically iterate and number them for you this way.
kjdelisle
deleted the
example-getting-started/connect-readme-to-tutorial
branch
The README now links back to the pathways for the tutorial, either on our docs site or in this
package.
connected to #729
continuation of #1001
Checklist
npm testpasses on your machinepackages/cliwere updatedpackages/example-*were updated