update vi-first-steps.md #2514
update vi-first-steps.md #2514
Conversation
Uploading the image that is being used in Fixes for Step 6 - adding more details for creating a new branch
pages/vi/vi-first-steps.md
Outdated
| @@ -49,11 +49,17 @@ There are 3 sections in this step: | |||
|
|
|||
| 1. [Vagrant Tutorial](vi-vagrant.md) | |||
| **Vagrant** is an open-source software product for building and maintaining portable virtual software development environments. In this section, you will learn about how to interact with Vagrant through the command-line interface. | |||
|
|
|||
| * **Summary of Step 1:** | |||
There was a problem hiding this comment.
The bullet points and the "Summary of Step X" are not necessary.
pages/vi/vi-first-steps.md
Outdated
| @@ -49,11 +49,17 @@ There are 3 sections in this step: | |||
|
|
|||
| 1. [Vagrant Tutorial](vi-vagrant.md) | |||
| **Vagrant** is an open-source software product for building and maintaining portable virtual software development environments. In this section, you will learn about how to interact with Vagrant through the command-line interface. | |||
|
|
|||
| * **Summary of Step 1:** | |||
| * By the end of this step, you should know how to set up your planet community on the command line/terminal, creating your planet learning account and learning about the different commands that will be used on the terminal for working with vagrant. | |||
There was a problem hiding this comment.
This part is not necessary; it is already stated in the previous paragraph.
pages/vi/vi-first-steps.md
Outdated
| @@ -86,6 +98,9 @@ Make sure you have created at least one issue, resolved it, commented on an issu | |||
|
|
|||
| Follow the directions under the [Nation Planet tab](vi-nation.md). | |||
|
|
|||
| * **Summary of Step 7:** | |||
| * In this step you learn about syncing your planet community with nation and also more on how to manage and checking the status of your syncs. | |||
|
@hemu-codes I don't see need of adding any of these summary. Because first paragraph of each step is explaining what step is about. And you will be taken to another detail page to do more stuff in there. So basically this overview page is itself a summary page. |
|
@lmmrssa I thought of adding this part due to the fact that the first paragraph of each step seems to have a lot of details that you might not necessarily want to read through if all you are looking for is where you learned how to do a certain step of the process. |
|
@lmmrssa I think some of this information could be useful though, when looking back at the steps i.e. to differentiate between "Planet tutorial" and "Nation Planet" when looking for the description of a specific feature. |
|
@Liew211 I have made the changes requested and notified you on Gitter but I wasn't sure if you had the chance to look at it again. Could you please look over this? Thanks |
|
@Liew211 @hemu-codes we do not want people to just rush and jump (skip) details. Otherwise we can just remove all details and make the 10 steps short. We want you to go through all details and learn the idea not just run some command and get it done. |
|
@lmmrssa The summary is not meant to give away everything we did in the whole step but rather just a refresher to what they did so if they need to go back to where they learned how to do a certain task, they don't have to browse through each page to know where to go. |
|
@hemu-codes I suggest you work on a different issue. Also, it does not need to be a big change. Small crucial/helpful changes are all welcome. |
Fixes #2507
Description
This is a pull request for issue #2507 and I updated to the original page by adding a summary of what is done in each step. This will help users in getting back to the right step if they forget how to do a certain task.
Raw.Githack preview link
https://raw.githack.com/hemu-codes/hemu-codes.github.io/add-step-summaries/#!pages/vi/vi-first-steps.md