Ftf 444 new dashboard docs #3061
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
franrob-projects
temporarily deployed
to
ably-docs-ftf-444-new-d-blwieh
franrob-projects
temporarily deployed
to
ably-docs-ftf-444-new-d-hxjycg
franrob-projects
temporarily deployed
to
ably-docs-ftf-444-new-d-hxjycg
franrob-projects
force-pushed
the
FTF-444-new-dashboard-docs
branch
from
0ca49ff to
c6b5ae7
Compare
franrob-projects
temporarily deployed
to
ably-docs-ftf-444-new-d-hxjycg
- Resolved conflict in src/pages/docs/platform/account/app/index.mdx by keeping HEAD version and removing misplaced push notification content - Resolved conflict in src/pages/docs/platform/account/app/products/push-notifications.mdx by keeping the new dashboard-focused title and description 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
franrob-projects
temporarily deployed
to
ably-docs-ftf-444-new-d-hxjycg
m-hulbert
left a comment
m-hulbert
left a comment
There was a problem hiding this comment.
I haven't finished reviewing the pages under /products or /platform/connections yet, but posting this feedback now for you to take a look at. Many of my inline comments relate to other pages/sections too. Additionally:
- All the pages that have been moved around need redirects.
- Need to update links throughout docs for all pages that reference the migrated pages.
- Might need some screenshots to break up the 100s of tables
- There's an awful lot of tables. They aren't necessarily wrong, but if you look through this section I'm not convinced they're always the best way to display every piece of info - especially when some of them have multiple columns saying very similar things. Take a look at the app management overview, or Pub/Sub overview for instance.
| @@ -0,0 +1,79 @@ | |||
| --- | |||
| title: Web client | |||
There was a problem hiding this comment.
I think you can just change the page title rather than the URL for this one for now.
There was a problem hiding this comment.
Not sure what you mean here sorry 🤔
| | **Push admin and push-subscribe** | Allow clients to manage and subscribe to push notifications. | | ||
| | **Statistics** | Allow clients to query usage statistics. | | ||
| | **Privileged headers** | Allow clients to set privileged headers, such as to skip channel rules. | | ||
| | Publish | Allow clients to publish messages to channels. | |
There was a problem hiding this comment.
This is missing quite a few capabilities that have been added since these were written.
| meta_keywords: "Integrations, configuration, webhooks, dashboard, Ably" | ||
| --- | ||
|
|
||
| The Integrations section in your Ably dashboard provides centralized management for connecting your Ably application with external services and systems. Configure and manage your integrations in the [app dashboard](https://ably.com/accounts/any/apps/any/settings/integrations) under the Integrations section. This interface enables you to configure webhooks, set up data streaming, and manage third-party integrations to extend your application's functionality. |
There was a problem hiding this comment.
I don't think this URL should have /settings/ in it .
| --- | ||
|
|
||
| The API keys tab lists all API keys associated with your account and provides information on each key's capabilities and restrictions. You can [create a new API key](#create) and manage an existing one. | ||
| The API keys tab lists all API keys associated with your account and provides information on each key's capabilities and restrictions. Manage your API keys in the [app dashboard](https://ably.com/accounts/any/apps/any/settings/keys) under the API Keys section. You can [create a new API key](#create) and manage an existing one. |
There was a problem hiding this comment.
This URL for the API keys isn't correct.
|
|
||
| The Integrations section in your Ably dashboard provides centralized management for connecting your Ably application with external services and systems. Configure and manage your integrations in the [app dashboard](https://ably.com/accounts/any/apps/any/settings/integrations) under the Integrations section. This interface enables you to configure webhooks, set up data streaming, and manage third-party integrations to extend your application's functionality. | ||
|
|
||
| ## Integration Rules <a id="integration-rules"/> |
There was a problem hiding this comment.
Can we simplify this page and just link off to the integrations section for each integration?
| | Element | Description | | ||
| |---------|-------------| | ||
| | Organization | Switch between different organizations you belong to, each potentially containing multiple accounts | | ||
| | Standalone accounts | Access individual accounts that aren't part of an organization structure | | ||
| | Account context | Select the specific account you want to manage, with each account displaying its associated pricing plan (Free, Enterprise, etc.) | |
There was a problem hiding this comment.
This table seems to complicate the hierarchy of orgs -> accounts -> apps rather than making it simpler
| * The statistics chart visualizes app usage data over time, allowing users to define specific time ranges, zoom in on different periods, and analyze metrics in detail. | ||
| The Apps section provides a centralized view of all your applications within the selected account: | ||
|
|
||
| | Element | Description | |
There was a problem hiding this comment.
This also seems to over-engineer a list of your current apps? Especially by listing app cards and quick actions as separate things, and the ability to create an app is relegated to a table row.
| Understand and manage your package [limits](/docs/platform/pricing/limits) by tracking usage across messages, data, connections, and channels: | ||
|
|
||
| * Limits are applied to prevent service disruption and vary by package. | ||
| * Limits can be time-based, quantity-based, or rate-based, and they may apply either per connection/channel or across the entire account. | ||
| * Notifications are provided when limits are nearing or exceeded, and detailed logs of warnings and exceeded limits are accessible in the account dashboard. |
There was a problem hiding this comment.
I'm not sure what we mean here with the part of the sentence starting "by tracking usage..."
Similarly the 3 bullet points are odd ones to choose to include.
| --- | ||
|
|
||
| The user that creates an Ably account is assigned the account owner role. An account owner has permission to undertake any action within an account, such as inviting new users. There are two other account roles that inherit a subset of an account owner's permissions. An account can only have a single account owner. | ||
| The user that creates an Ably account is assigned the account owner role. An account owner has permission to undertake any action within an account, such as inviting new users. There are two other account roles that inherit a subset of an account owner's permissions. An account can only have a single account owner. Manage users through your [account dashboard](https://ably.com/accounts/any) under the Users section. |
There was a problem hiding this comment.
Should this link directly to users page?
| @@ -0,0 +1,248 @@ | |||
| --- | |||
| title: Chat app management | |||
There was a problem hiding this comment.
I don't think the 'app' part is correct for all these pages, as they are all in the same app.
This PR:
Reorganizes app management pages into new sections:
Creates pages for tracking app performance and debugging:
Adds pages for moitoring:
Creates pages for Settings management within the dashboard:
Restructures the platform navigation (it was becoming a little hidden away given the effort).
Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.