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

Events docs revamp #8360

Merged
merged 15 commits into from
Oct 8, 2024
Merged
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event logs](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

## Flag Automation and Workflow Integration for Django Apps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ var responseBody = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseBody);
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event logs](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation and Workflow Integration for .NET Apps

Expand Down
2 changes: 1 addition & 1 deletion website/docs/feature-flag-tutorials/ios/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ curl -L -X GET '<your-unleash-url>/api/admin/events/:featureName' \
-H 'Authorization: <API_KEY_VALUE>'
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/events) to learn more.
Read our documentation on [Event logs](/reference/events#event-log) and [APIs](/reference/api/unleash/events) to learn more.

## Change Management & Feature Flag Approvals in iOS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ For our Spring Boot app, we can view Event logs to monitor the changes to flag s

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](/img/spring-boot-events-log.png)

You can also retrieve event log data by using an API command. Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
You can also retrieve event log data by using an API command. Read our documentation on [Event logs](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation & Workflow Integration for Java Apps

Expand Down
2 changes: 1 addition & 1 deletion website/docs/feature-flag-tutorials/python/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event logs](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation & Workflow Integration for Python Apps

Expand Down
4 changes: 2 additions & 2 deletions website/docs/feature-flag-tutorials/rails/rails-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ You can view Event logs to monitor the changes to flag strategies and statuses,
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](../ruby/event-logs.png)
![Event logs in Unleash track every single change made to flags, similar to Git commit history.](../ruby/events#event-logs.png)
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

You can also retrieve event logs by using an API command, like below:

Expand All @@ -333,7 +333,7 @@ response = HTTPX.get(url, headers: headers)
puts response.body
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event logs](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation and Workflow Integration for Rails Apps

Expand Down
2 changes: 1 addition & 1 deletion website/docs/feature-flag-tutorials/react/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ curl -L -X GET '<your-unleash-url>/api/admin/events/:featureName' \
-H 'Authorization: <API_KEY_VALUE>'
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/events) to learn more.
Read our documentation on [Event logs](/reference/events#event-log) and [APIs](/reference/api/unleash/events) to learn more.

## Change Management & Feature Flag Approvals in React

Expand Down
4 changes: 2 additions & 2 deletions website/docs/feature-flag-tutorials/ruby/ruby-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ You can view Event logs to monitor the changes to flag strategies and statuses,
- How the gradual rollout strategy was configured
- When and how the variants were created and configured

![Event logs in Unleash track every single change made to flags, similar to Git commit history.](./event-logs.png)
![Event logs in Unleash track every single change made to flags, similar to Git commit history.](./events#event-logs.png)
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

You can also retrieve event logs by using an API command, like below:

Expand All @@ -332,7 +332,7 @@ response = HTTPX.get(url, headers: headers)
puts response.body
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event logs](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation & Workflow Integration for Ruby Apps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ fn main() -> Result<(), Box<dyn Error>> {
}
```

Read our documentation on [Event logs](/reference/event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.
Read our documentation on [Event logs](/reference/events#event-log) and [APIs](/reference/api/unleash/get-events-for-toggle) to learn more.

## Flag Automation and Workflow Integration for Rust Apps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Unleash provides the data to log any change that has happened over time, at the

![The event log for a feature flag. The "Event log" tab is highlighted and the UI shows the most recent changes, including a JSON diff and the change details.](/img/unleash-toggle-history.png)

Learn more about [event logs](/reference/event-log/) in our documentation.
Learn more about [event logs](/reference/events#event-log/) in our documentation.

### Managing Change Requests

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Filters are completely optional, so if you don't configure any filter your actio

### Actions

When these actions are triggered, they will execute under the identity of a [service account](./service-accounts.md). This means that when you later check the [event log](./event-log) you will see this service account as the actor for those events. In order to execute the configured actions successfully, this service account needs to have the necessary permissions. This service account doesn't need an API token, so when creating it you can skip the token generation step and simply make sure it has the necessary permissions.
When these actions are triggered, they will execute under the identity of a [service account](./service-accounts.md). This means that when you later check the [event log](./events#event-log) you will see this service account as the actor for those events. In order to execute the configured actions successfully, this service account needs to have the necessary permissions. This service account doesn't need an API token, so when creating it you can skip the token generation step and simply make sure it has the necessary permissions.

The actions are executed in the same order that they are defined. If a previous action fails, the following actions will not be started. You can add multiple actions to an action set and you can add multiple action sets to a project. Depending on the action you want to execute you will have to provide different parameters.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/reference/api/legacy/unleash/admin/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In order to access the admin API endpoints you need to identify yourself. Unless

:::

The Events API lets you retrieve [events](/reference/event-types.mdx) from your Unleash instance.
The Events API lets you retrieve [events](/reference/events.mdx) from your Unleash instance.

## Event endpoints

Expand Down Expand Up @@ -131,6 +131,6 @@ The list of events related to the given toggle.

:::note Content moved

This section has been moved to a dedicated [event type reference document](/reference/event-types.mdx).
This section has been moved to a dedicated [events documentation](/reference/events.mdx).

:::
21 changes: 0 additions & 21 deletions website/docs/reference/event-log.md

This file was deleted.

Loading
Loading