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

Manage user v2 docs #405

Merged
merged 5 commits into from
Feb 13, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix more broken links and video embed
aleksa-krolls committed Feb 13, 2024
commit 29e2fc94c87add2e4f3ab9dd82b7f61ae6fe6cb1
13 changes: 9 additions & 4 deletions docs/build/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -3,13 +3,18 @@ title: Troubleshooting integrations
sidebar_label: Troubleshooting
---

Or, a penny for your thoughts during the debugging process.

<!--truncate-->

So, you've noticed that something isn't quite right. Here's a list of questions,
and complications, that might help you get to the bottom of it.

:::tip

Check out the [Troubleshooting page](../monitor-history/troubleshooting.md) in
the "Monitor History" section for more specific tips and common errors.

:::

<!--truncate-->

## The Implementation Perspective

First, keep this quick checklist at hand... answering these questions _in order_
4 changes: 2 additions & 2 deletions docs/manage-projects/link-to-gh.md
Original file line number Diff line number Diff line change
@@ -44,7 +44,7 @@ Click `Configure`...
Your whole OpenFn project can be represented as a project.yaml file.

Using our Command Line Interface, the
[@openfn/cli](../deploy/portability#using-the-cli-to-deploy-or-describe-projects-projects-as-code)
[@openfn/cli](../deploy/portability.md)
you can pull a project config from OpenFn to a folder or repo on your computer,
and you can deploy a change in your project.yaml file from that directory or
repo to OpenFn.
@@ -55,4 +55,4 @@ keep a repository in sync with your OpenFn project.

For more detailed information on representing your project as code and using the
@openfn/cli, head over to our documentation on
[Portability](../deploy/portability).
[Portability](../deploy/portability.md).
6 changes: 3 additions & 3 deletions docs/monitor-history/inspect-runs.md
Original file line number Diff line number Diff line change
@@ -3,13 +3,13 @@ title: Inspect Runs & Search via the History page
sidebar_label: Inspect Runs
---

A [Run](/documentation/get-started/terminology#run) is created each time
A [Run](../get-started/terminology.md#run) is created each time
OpenFn attempts to excute a Workflow for a given Work Order. All Runs can be
viewed, filtered, and searched via the `History` page.

In short, Runs tell us "what happened" when OpenFn tried to execute the
Workflow. Runs have start times, end times, logs, and
[status codes](/documentation/monitor-history/status-codes) that indicate
[status codes](./status-codes.md) that indicate
when they took place, what they did, and whether or not they succeeded.

## Inspect Runs
@@ -26,4 +26,4 @@ To learn how to search and filter Work Order and Run history via the History
page, check out the below video tutorial
([or see link](https://youtu.be/XIUykmLCxwQ?si=pCzefw4zyLxG1voE)).

<iframe width="8" height="441" src="https://www.youtube.com/embed/XIUykmLCxwQ?si=IM73HvXEC2Azg5YF" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="784" height="441" src="https://www.youtube.com/embed/XIUykmLCxwQ?si=IM73HvXEC2Azg5YF" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
8 changes: 4 additions & 4 deletions docs/monitor-history/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -8,14 +8,14 @@ This page provides troubleshooting tips for *OpenFn v2 platform* users.
## Runs

One of the most helpful pages for troubleshooting on OpenFn is the
[History](/documentation/monitor-history/activity-history) page.
This page provides a list of all of the runs executed for a Work Order and their status. Project administrators can troubleshoot errors by clicking into the run to review the run details. Learn more about runs [here](/documentation/monitor-history/inspect-runs) here.
[History](./activity-history.md) page.
This page provides a list of all of the runs executed for a Work Order and their status. Project administrators can troubleshoot errors by clicking into the run to review the run details. Learn more about runs [here](./inspect-runs.md) here.

### Status codes

Every run will have a status code. The status code is a way for OpenFn to classify
the run status and can help you troubleshoot errors. Learn more about OpenFn
status codes and what each one means [here](/documentation/monitor-history/status-codes).
status codes and what each one means [here](./status-codes.md).

### The time it took for the workflow to fail

@@ -89,7 +89,7 @@ Check out this [video](https://youtu.be/XIUykmLCxwQ?si=hquc8rPTJrAZkbbD) for how

## Sign up for email alerts

You can turn on notifications to receive [email alerts](/documentation/manage-projects/notifications) when a workflow fails and subscribe to digests that summarize project activity.
You can turn on notifications to receive [email alerts](../manage-projects/notifications.md) when a workflow fails and subscribe to digests that summarize project activity.

## More