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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): add documentation on workflow concepts #721

Closed
wants to merge 1 commit into from

Conversation

czosel
Copy link
Contributor

@czosel czosel commented Oct 6, 2019

Turns out vacation is the perfect environment to write some documentation 馃槄

Rendered

This adds a draft for the first chapter for the documentation of Caluma's workflow system. I thought of the following structure:

  1. concepts (workflow, tasks, cases, work items and how they fit together)
  2. implementation (how those concepts can be applied on the GraphQL API)
  3. supported workflow patterns

Where those docs go probably still needs to be discussed - I figured I'd just start on the content in the meantime 馃槈

I'd appreciate some feedback on this - I tried to set the barrier of entry relatively low and to explain the basics in detail. This is not meant as a technical reference, more as tutorial/guide. A bit like the Ember.js guides. If you agree with the direction this is headed, I'll add chapter two which exists as an analog draft already.

@open-dynaMIX @kaldras @anehx @ganwell @winged

@winged
Copy link
Contributor

winged commented Oct 7, 2019

Awesome work!

But that keming tho...

Copy link
Contributor

@winged winged left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it!

However the SVGs contain an uncommon font, or something, as they render in a quite ugly way on my machine. Might wanna change that

@czosel
Copy link
Contributor Author

czosel commented Oct 7, 2019

Good call! I used Oxygen, the same font as on the caluma.io website. Probably not a good idea if the font is not embedded into the svg - I鈥檒l look into it.

@open-dynaMIX
Copy link
Member

Great work! 馃挴

@sbor23
Copy link

sbor23 commented Oct 9, 2019

Looking good, certainly clear enough for n00b in caluma like me.
Eagerly awaiting the last chapters. ;)
馃

@winged
Copy link
Contributor

winged commented Oct 10, 2019

Cleaned it up a bit in #723, and merged by @open-dynaMIX

@winged winged closed this Oct 10, 2019
@anehx anehx deleted the workflow-docs branch March 2, 2022 10:34
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.

None yet

4 participants