Added getting started to documentation #5500
Conversation
* Created Tutorial Overview * Moved all the Tutorials into getting-started sub-directory of intro
| * **<a href="../getting-started/tutorial-1.html">Part 1: Top-level Architecture</a>** | ||
| * **<a href="../getting-started/tutorial-2.html">Part 2. The Device Actor</a>** | ||
| * **<a href="../getting-started/tutorial-3.html">Part 3. Device Groups and Manager</a>** | ||
| * **<a href="../getting-started/tutorial-4.html">Part 4. Querying a Group of Devices</a>** |
There was a problem hiding this comment.
The purpose of this is to provide an over view on the nature of the application the tutorial was about. I gave a link to the various parts at the bottom.
| <body> | ||
| <p>This page has been moved to <a href="../intro/getting-started/tutorial-1.html">Part 1. Top-level Architecture</a>.</p> | ||
| </body> | ||
| </html> |
There was a problem hiding this comment.
For this and the rest, this is for backward compatibility.
docs/articles/toc.yml
Outdated
| - name: Use-case and Deployment Scenarios | ||
| href: intro/use-case-and-deployment-scenarios.md | ||
| - name: Production Users and Use Cases for Akka.NET | ||
| href: intro/akka-users.md | ||
| - name: Getting Started |
There was a problem hiding this comment.
To put all tutorials under this section
There was a problem hiding this comment.
Ah, so rather than have one giant toc.yml here we should probably have each folder use its own toc.yml and then just reference that from the main articles/toc.yml - we need to add this as part of our DocFx Hygiene Guidelines
There was a problem hiding this comment.
Just need to make one change to toc.yml, but otherwise this looks good.
Have you tested your changes locally in DocFx to ensure that they work? @eaba
docs/articles/toc.yml
Outdated
| - name: Use-case and Deployment Scenarios | ||
| href: intro/use-case-and-deployment-scenarios.md | ||
| - name: Production Users and Use Cases for Akka.NET | ||
| href: intro/akka-users.md | ||
| - name: Getting Started |
There was a problem hiding this comment.
Ah, so rather than have one giant toc.yml here we should probably have each folder use its own toc.yml and then just reference that from the main articles/toc.yml - we need to add this as part of our DocFx Hygiene Guidelines
Yes, tested locally. That helped me a lot in understanding what I was doing! |
… into documentation_update
Part fix for #5483
Changes
Moved all the tutorials under
introductionto it own sectionChecklist
For significant changes, please ensure that the following have been completed (delete if not relevant):