Skip to content

Patch Feature/syntax checking#134

Merged
SchettlerKoehler merged 70 commits intodevonfw-tutorials:mainfrom
MarcelDiessner:feature/syntaxChecking
Jun 15, 2021
Merged

Patch Feature/syntax checking#134
SchettlerKoehler merged 70 commits intodevonfw-tutorials:mainfrom
MarcelDiessner:feature/syntaxChecking

Conversation

@MarcelDiessner
Copy link
Copy Markdown
Collaborator

What will the user learn in your tutorial?

What should the user already know when starting the tutorial?

MarcelDiessner and others added 24 commits June 11, 2021 12:11
* moved get branch
@github-actions
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown

Thanks for submitting your work on a (new) tutorial!

Some suggestions, which might help:

  • Title: Focus on what you want to train in a few words. Don't be too generic
  • Tutorial:
    • Address the user directly.
    • Explain why the steps are necessary.
    • Explain what are the results and why are they necessary for your next step.
    • Forward the user to more elaborate documentation on the website (deep links) for further reading

Also please find further help for creating tutorials here or more help regarding the tutorial syntax here.

You can view the generated tutorials of this PR here in a few minutes. You just have to wait for the run of the deployment action to finish.

When you think you are done writing the tutorial try the tutorial on the deveplopment area and check if you explained every step in a way someone who is trying to learn what you are teaching can understand. Ideally ask someone to have a look on what you have done and have that part double checked because this is very important.

@SchettlerKoehler SchettlerKoehler merged commit 0e035ef into devonfw-tutorials:main Jun 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants