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

x/website/_content/doc/tutorial: tutorials leave developer in broken state #50435

Open
arick opened this issue Jan 4, 2022 · 1 comment
Open
Labels
NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone

Comments

@arick
Copy link

arick commented Jan 4, 2022

At the end of tutorial, "Add a test", the tutorial leaves the code in a broken state. The next tutorial "Compile and install the application", assumes that the code is fully functional.

I recommend that the fix be done in the "Add a test" tutorial, so that the user is left with a working example, as that is where the code was initially broken. Otherwise, if the fix is done in Compile and install the application, the text would have to deal with the developer who goes directly to that tutorial, without going through the previous tutorials.

If the fix is done in "Add a test" tutorial, you just need to add a paragraph that has the developer edit the broken file, by un-commenting the working code, and deleting the broken code.

@ianlancetaylor ianlancetaylor changed the title Tutorials leave developer in broken state x/website/_content/doc/tutorial: tutorials leave developer in broken state Jan 4, 2022
@ianlancetaylor ianlancetaylor added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Jan 4, 2022
@ianlancetaylor ianlancetaylor added this to the Unreleased milestone Jan 4, 2022
@ianlancetaylor
Copy link
Contributor

CC @stevetraut

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
None yet
Development

No branches or pull requests

2 participants