Add typical workflow to README #654
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sambostock
requested review from
kencwng,
nvasilevski and
adrianna-chang-shopify
adrianna-chang-shopify
approved these changes
Jun 20, 2022
README.md
Outdated
| - or by [using Ruby](#running-a-task-from-ruby) | ||
| 3. [Monitor the Task](#monitoring-your-tasks-status) | ||
| - either by using the included web UI, | ||
| - or by manually checking your task's run's state in your database |
There was a problem hiding this comment.
Nit for consistency
Suggested change
| - or by manually checking your task's run's state in your database | |
| - or by manually checking your task's run's status in your database |
There was a problem hiding this comment.
Suggested change
| - or by manually checking your task's run's state in your database | |
| - or by manually checking your task's run's status in your database. |
There was a problem hiding this comment.
This is a private API, not sure we should mention it really.
There was a problem hiding this comment.
Fair point, but I see two reasons to keep it:
- It mirrors the items above it by mentioning a non web-ui way to accomplish the task.
- In the "Monitoring your Task's status" section we give a detailed list of every single state and what it means, so it's arguably not quite totally private. 🤔
etiennebarrie
approved these changes
Jun 20, 2022
README.md
Outdated
| - or by [using Ruby](#running-a-task-from-ruby) | ||
| 3. [Monitor the Task](#monitoring-your-tasks-status) | ||
| - either by using the included web UI, | ||
| - or by manually checking your task's run's state in your database |
There was a problem hiding this comment.
Suggested change
| - or by manually checking your task's run's state in your database | |
| - or by manually checking your task's run's status in your database. |
README.md
Outdated
| - or by [using Ruby](#running-a-task-from-ruby) | ||
| 3. [Monitor the Task](#monitoring-your-tasks-status) | ||
| - either by using the included web UI, | ||
| - or by manually checking your task's run's state in your database |
There was a problem hiding this comment.
This is a private API, not sure we should mention it really.
sambostock
force-pushed
the
typical-workflow
branch
from
67f7018
to
076b6b7
Compare
|
I've addressed the punctuation comments. I'm going to merge leaving the database section for now to get the improved docs in; we can always iterate and remove it later if we so choose. |
Currently, it is easy to overlook the section mentioning running tasks via the web UI. By adding a typical workflow, and some section headings, we make this clearer.
sambostock
force-pushed
the
typical-workflow
branch
from
076b6b7
to
240ecb3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, it is easy to overlook the section mentioning running tasks via the web UI. By adding a typical workflow, and some section headings, we make this clearer.