Skip to content

Commit

Permalink
docs fixes (#2907)
Browse files Browse the repository at this point in the history
### Description of change

##### Checklist

- [ ] Tested in playground or other setup
- [ ] Screenshot (Grafana) from playground added to PR for 15+ minute
run
- [ ] Documentation is changed or added
- [ ] Tests and/or benchmarks are included
- [ ] Breaking changes


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
	- Reorganized the sidebar navigation for improved user experience.
- Updated the "Aperture Cloud" section in the FAQ with information about
hosted Agent for SDK integration.
- Revised the "Aperture" introduction, removing the mention of "control
plane" and updating availability options.
- Modified the file path for an included file in the "Flow Lifecycle"
document.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
sudhanshu456 authored Nov 6, 2023
1 parent 2a6f241 commit 7399b54
Show file tree
Hide file tree
Showing 15 changed files with 16 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/content/concepts/advanced/auto-scale.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Auto Scale
sidebar_position: 13
sidebar_position: 7
keywords:
- auto-scaling
- Autoscaling
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/advanced/circuit.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Circuit
sidebar_position: 2
sidebar_position: 9
---

:::info See also
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/advanced/classifier.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Classifier
sidebar_position: 7
sidebar_position: 3
---

:::info See also
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/advanced/dynamic-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Dynamically configuration of policy
keywords:
- policy
- configuration
sidebar_position: 3
sidebar_position: 10
---

Aperture's policies can be thought of as "Load Management Applications" running
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/advanced/flux-meter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Flux Meter
sidebar_position: 8
sidebar_position: 4
keywords:
- fluxmeter
- histograms
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/advanced/infra-meter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Infra Meter
sidebar_position: 9
sidebar_position: 5
keywords:
- telemetry
- monitoring
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/advanced/load-ramp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Load Ramp
sidebar_position: 10
sidebar_position: 6
---

:::info See also
Expand Down
4 changes: 1 addition & 3 deletions docs/content/concepts/advanced/policy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Policy
sidebar_position: 1
sidebar_position: 8
sidebar_label: Policy Language
---

Expand Down Expand Up @@ -58,8 +58,6 @@ objectives and trigger appropriate actions to restore system stability and
reliability. The circuit is the heart of the policy specification and is
responsible for the logic of the control system.

<DocCardList />

## Resources

:::info See also
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/advanced/service.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Service
sidebar_label: Service
sidebar_position: 3
sidebar_position: 2
keywords:
- Service Discovery
---
Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/flow-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ back to the service.
<Zoom>

```mermaid
{@include: ./assets/gen/service/flow-lifecycle.mmd}
{@include: ./assets/gen/flow-lifecycle/flow-lifecycle.mmd}
```

</Zoom>
Expand Down
3 changes: 3 additions & 0 deletions docs/content/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@ Aperture Agent is a binary that can be run on the
[Supported Linux platforms](/self-hosting/supported-platforms.md). The
installation steps are available [here](/self-hosting/agent/bare-metal.md).

Note: Aperture Cloud also provides a hosted Agent for SDK integration, allowing
you to use it by API instead of deploying your own Aperture Agents.

### What are Aperture Agent's performance numbers? {#agent-performance}

The Aperture Agent is designed to be lightweight and performant.
Expand Down
6 changes: 3 additions & 3 deletions docs/content/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ in a cloud application:
![Unified Load Management (dark)](./assets/img/unified-load-management-dark.svg#gh-dark-mode-only)
![Unified Load Management (light)](./assets/img/unified-load-management-light.svg#gh-light-mode-only)

Aperture's control plane is available as a managed service, [Aperture
Cloud][cloud], or can be [self-hosted][self-hosted] within your infrastructure.
Visit the [Architecture][architecture] page for more details.
Aperture is available as a managed service, [Aperture Cloud][cloud], or can be
[self-hosted][self-hosted] within your infrastructure. Visit the
[Architecture][architecture] page for more details.

:::info Sign-up

Expand Down

0 comments on commit 7399b54

Please sign in to comment.