open-learning-exchange.github.io
open-learning-exchange.github.io copied to clipboard
open-learning-exchange
Suggestion to improve clarity for First Steps
Problem
It can be confusing to navigate between tabs and through links while working on the First Steps.
Proposed solution
I think that this can be somewhat mitigated if the sub-steps were numbered as well. Some links could also be added to help with navigation.
For example, instead of Planet Installation at the top of a sub-step, it could be titled 1.1 - Planet Installation to provide more clarity. First Steps > Step 1 - Planet and Vagrant > Planet Installation (1 of 3) could also be added to the top or bottom of the page along with the appropriate links to display the total number of sub-steps.
Screenshots
I would rather have numbering only under First Steps documentation instead of having on each sub pages.
Ah, it is the wording isn't it @jazdao? Maybe we can use something link Getting Started, have better idea @jazdao or @coder8102?
hi @jazdao, I agree navigation can be a little tricky, what I thought would be helpful is maybe having just one link for each step, and a little description under, without more links to follow because makes me wonder if I missed something in there (like missing a link or something)
@jazdao I think step 1 will be consisted by 3 parts, one is Planet Installation with vagrant, second is Planet Configurations and third is Vagrant Tutorial. And for each parts there is a link to a page which will be the explanation of each part in detail.
Although this may take a lot of time due to reformatting, I believe this could actually be really useful for the user. It would make everything extremely clear and if they do ask questions in gitter, people could easily understand what the intern is addressing.
I don't know if this is still being worked on but I agree that it would be useful to have. Having indices for procedures always makes things easier to navigate, both for the intern in question as well as if a question is asked about a particular substep on Gitter.
This is a really good idea. The main advantage is clarifying which substep people are on when they need to refer to them, as substeps still cover the same topics as the main step. I don't think we need to say "(1 out of 3)" or something similar though - just numbering with 1.1, 1.2, etc. should be good enough.
It is a good idea, but I do not think it is really necessary because we already have the numbering on the main First steps page which also states that we have 3 sections in that step, and when we go into the first section, after the completion of that step near the bottom of that page there is a link to the next section, and also a link to go back to the main page.
I agree, its a lot easier to reference a number, i.e Step 6.3 rather than saying Step 6: Github Issues, create an issue section. Especially when creating titles for issues,
