Add documentation images #151
Conversation
| * Every **orchestrator** (local, Google Cloud VMs, etc) can run all **pipeline steps**, including training. | ||
| * **Orchestrators** have a selection of compatible **processing backends**. | ||
| * **Pipelines** can be configured to utilize more powerful **processing** (e.g. distributed) and **training** (e.g. Google AI Platform) **executors**. | ||
| - Every **orchestrator** (local, Google Cloud VMs, etc) can run all **pipeline steps**, including training. |
There was a problem hiding this comment.
Are these all automatic from your linter? We should standardize it otherwise it becomes hard to review markdown. Can you share the tools your using? Maybe we can add a pre-commit hook?
There was a problem hiding this comment.
Yeah sorry about that.
I think it is prettier which is taking out extra spaces on the ends of lines.
https://prettier.io/docs/en/precommit.html shows how it'd integrate with precommit.
I imagine there will be some overlap with some things we already have? For markdown, my settings are:
"arrowParens": "always",
"bracketSpacing": true,
"endOfLine": "lf",
"htmlWhitespaceSensitivity": "css",
"insertPragma": false,
"jsxBracketSameLine": false,
"jsxSingleQuote": false,
"printWidth": 80,
"proseWrap": "preserve",
"quoteProps": "as-needed",
"requirePragma": false,
"semi": true,
"singleQuote": false,
"tabWidth": 2,
"trailingComma": "es5",
"useTabs": false,
"vueIndentScriptAndStyle": false,
"filepath": "/Users/strickvl/coding/zenml/repos/zenml/docs/book/guides/low-level-api/chapter-7.md",
"parser": "markdown"
There was a problem hiding this comment.
Would you mind adding it to the whole dev cycle? Including adding a new script and editing our pre-commit hook?
There was a problem hiding this comment.
Added in a separate branch.
|
@htahir1 I put the prettier code in a separate branch / draft PR request. This branch should be good to go for now. |
Pre-requisites
Please ensure you have done the following:
Types of changes
Describe changes
Updated architectural diagram
Added quickstart diagram
Added two stack diagrams (to ch. 7 of the guide)