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

WIP: Cobigen Template Creation Tutorial #174

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

MikeSchumacherCapgemini

What will the user learn in your tutorial?

Adapting existing cobigen templates to fit generation results to their requirements
Creating a new template that will generate what the user wants

What should the user already know when starting the tutorial?

The language the user wants to be generated
Knowledge about Freemarker template language (Access to documentation should be enough)
Java knowledge for supplementary functions that can't be done with Freemarker

@github-actions
Copy link

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.

@MikeSchumacherCapgemini MikeSchumacherCapgemini marked this pull request as draft September 27, 2021 09:44
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.

1 participant