Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tour: solutions repository not linked anywhere in the tour #542

Open
ALTree opened this issue Jul 2, 2018 · 4 comments · May be fixed by golang/website#67
Open

tour: solutions repository not linked anywhere in the tour #542

ALTree opened this issue Jul 2, 2018 · 4 comments · May be fixed by golang/website#67
Labels
help wanted NeedsFix The path to resolution is known, but the work has not been done.

Comments

@ALTree
Copy link
Member

ALTree commented Jul 2, 2018

As far as I can tell, the solutions to the tour exercises in the /solution folder are not linked in the tour. Users that run the tour locally from the repo may see the folder, but the ones that visit the online version of the tour won't.

The solutions repo at https://github.com/golang/tour/tree/master/solutions should be linked somewhere.

Either in the introduction, or in the slide of the first exercise.

@ALTree ALTree added help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Jul 2, 2018
@bgadrian
Copy link
Contributor

I think the link should be present on all exercises? I presume the users will not open the solutions at the first slide, nor return 10 lessons back for the link (presuming that he remembers there was a link).

@ALTree
Copy link
Member Author

ALTree commented Jul 12, 2018

think the link should be present on all exercises?

This seems excessive. I don't think we want to encourage people to immediately look at the exercise solution, maybe without even trying to solve it. I suspect it may be the reason the solution are not currently linked everywhere. This may be a little excessive, and it could be fixed by adding a small note once that links the URL of the solutions.

The goal is to make people aware of the fact that solutions exist (which is what the people opening issues here asking for solutions don't know), not to make it easy to immediately look at the solution of a specific exercise.

@bgadrian
Copy link
Contributor

Ok, if that is the intent of the exercises make sense.

I think it contravenes with the scope of the tour, I mean is more important that the users solve the problem, even if is copy paste, more importantly they see how Go code should be written. The fact that they know mathematics, image processing or other exercises is pretty irrelevant to the bigger scope.

Anyway, we could insert a new blank page, before the first exercise, with the README from the /solution folder and a link?

The Notes of the first exercise already has a lot of text, so I don't think it would be a good fit.

@ALTree
Copy link
Member Author

ALTree commented Jul 17, 2018

I mean is more important that the users solve the problem, even if is copy paste

I disagree. The most important thing it that the use tries to solve the problem by writing code. The exercises are meant to be slightly more difficult than the code examples in the tour, and the point is to encourage a three step learning experience by 1) introducing a concept 2) showing a simple usage example 3) challenging the user to use the concept in a more difficult context

Anyway, we could insert a new blank page, before the first exercise, with the README from the /solution folder and a link?

A whole page seems overkill (there are already a few almost empty pages, adding one for something that should be a small note is IMO unnecessary). In the welcome page, it says

Throughout the tour you will find a series of slides and exercises for you to complete.

maybe a small note with the link could be appended there?

JackMeadDev pushed a commit to JackMeadDev/tour that referenced this issue Oct 10, 2018
sagar23sj added a commit to sagar23sj/website that referenced this issue Jun 15, 2021
Existing content does not mention the solution repository link for exercises in tour.
New changes added link of solution to the exercies.

Fixes: golang/tour#542
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
2 participants