Various minor fixes to the Definition of DONE #328
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
documentation/Definition of DONE.md
Outdated
| * I proofread my tutorial: | ||
| 1. Are the steps available and in the correct order? | ||
| 1. Are there any spelling mistakes? | ||
| 1. Does everything make sense? | ||
| * I ran through the latest update of my tutorial in Katacoda-Dev and checked if everything was working as intended BEFORE requesting a review. | ||
|
|
||
| # **Technical** | ||
| * The files that were used in `nextKatacodaStep `are available in `.asciidoc` files and do not contain Katacoda Syntax. `nextKatacodaStep` is almost never needed. | ||
| * The files that were used in `nextKatacodaStep `are available in `.asciidoc` files and do not contain Katacoda Syntax. | ||
| * The name of the function `nextKatacodaStep ` has been changed to make it clearer that there is no functional content allowed. Now it is called `displayContent ` |
There was a problem hiding this comment.
Why don't you just use the name displayContent. I think it is a bit confusing when you first mention nextKatacodaStep and then displayContent. We should remove nextKatacodaStep as it is not used anymore.
There was a problem hiding this comment.
@GuentherJulian Then I guess I should remove the entire sentence , as the sole purpose of mentioning nextKatacodaStep here was to remind the tutorial-makers to not use it. But it was renamed entirely so we do not need to mention it at all.
There was a problem hiding this comment.
Yes, just mention displayContent and that no Katacoda syntax should be used inside files used in this step
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.