Beautification of Examples

[AlexejPenner]

Describe changes

I have started working on the examples and wanted to check in early to see if this is what you had in mind?

For now I would appreciate just a quick glance without going into detail so that I can know if I'm going into the correct direction.

Pre-requisites

Please ensure you have done the following:

• I have read the CONTRIBUTING.md document.
• If my change requires a change to docs, I have updated the documentation accordingly.
• If I have added an integration, I have updated the integrations table.
• I have added tests to cover my changes.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Other (add details above)

[strickvl]

Took a quick look at this, but I guess this PR got overshadowed by our conversation in discord.

As one piece of context, it was the nba-pipeline zenfile that originally made me think that the examples wanted beautifying. So I would suggest that (depending on what we end up doing with the examples etc) maybe as a first step for beautifying these individual entities would be to give them the same love and care (emojis, diagrams, clear explanations etc) that you gave the nba-pipeline zenfile? But that of course is pending our bigger decisions about what's happening to the examples in the first place...

[schustmi]

Small chunk of changes for the Introduction docs section

[schustmi]

Developer guide comments

[schustmi]

I also have some more comments:

• We have a lot of overlap between the sections stack components, core concepts and glossary. Do they all have a different scope or can we somehow link to each other to prevent duplicated efforts?
• Our "placeholders" in CLI commands are all over the place:
  • Some are just uppercase: zenml stack register STACK_NAME
  • Some are with dollar signs: zenml stack register $STACK_NAME (or $stack_name)
  • Some are with these guys <>: zenml stack register <STACK_NAME>
    I vote for having these unified, with a preference for the last option mainly as gitbook already colors them (<>) differently and therefore makes it easier to detect placeholder values

[schustmi]

More random comments