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 Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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
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.
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
fd7f5c0 to
aba3148
Compare
franrob-projects
added
review-app
GregHolmes
force-pushed
the
FTF-444-new-dashboard-docs
branch
from
51e1074 to
ad76dea
Compare
| title: App management overview | ||
| meta_description: " Manage and monitor your applications on the Ably platform using the Ably dashboard. Create new apps, view existing ones, and configure settings from your browser." | ||
| meta_keywords: “Ably dashboard, manage applications, monitor apps, app creation, application settings, Ably platform” | ||
| redirect_from: |
There was a problem hiding this comment.
If we're updating the location of the file, which then updates the url. Should we also add a redirect_from in here?
GregHolmes
force-pushed
the
FTF-444-new-dashboard-docs
branch
from
c9ce54e to
3bad97b
Compare
GregHolmes
force-pushed
the
FTF-444-new-dashboard-docs
branch
from
3bad97b to
c0a25a9
Compare
m-hulbert
left a comment
m-hulbert
left a comment
There was a problem hiding this comment.
Is it just me or are the images blurry? They also have random 1s on the end of file names.
There's a few random fixes to things (bullets, spelling that should be in their own commit really as they're unrelated to the majority of this PR). Along side that we've also got some AI smells creeping in like replacing colons with dashes in lists.
The file structure gets a bit hairy with /platform/X/platform - maybe worth a review but happy to keep if you think it makes sense.
|
|
||
| The Ably CLI brings the full power of Ably to your terminal. You can use it to manage your Ably account and its resources, and to explore Ably's APIs and features. | ||
|
|
||
|  |
There was a problem hiding this comment.
If we're putting this image here for the CLI then I think we need something on this page to say it's available in the dashboard too.
There was a problem hiding this comment.
Added a sentence in the previous paragraph: e34157d
| ### Provision a new queue | ||
| ### Provision a new queue <a id="provision-queue"/> | ||
|
|
||
| When creating a new queue, you need to specify: |
There was a problem hiding this comment.
I think this should have stayed as a table to avoid bullet point bloat.
There was a problem hiding this comment.
I've added an extra column (Type) so just fixedup to the original commit: 60ee3a2
There was a problem hiding this comment.
This seems to have been partially replaced by teams.mdx but has been dropped from the navigation. There's still some info here that's relevant to retain, so I'm not sure it's appropriate to remove it.
There was a problem hiding this comment.
Slight mismatch between the title and the page name +/- s.
The bigger question I have is trying to work out what this page is supposed to be. It's redirecting from organisations but has a lot of info that's duplicated in user management and SSO (SCIM info etc.)
There was a problem hiding this comment.
This page is being redirected to teams.mdx so can never be reached.
| 1. Use the connection finder search box to filter by connection ID or client ID. | ||
| 2. Use the country filter to view connections from specific geographic locations. | ||
| 3. Use the SDK filter to view connections using specific client SDK versions. |
There was a problem hiding this comment.
This isn't an ordered list that you'd always do.
|
|
||
| For each attached channel, the interface shows the channel name, connection modes (presence, publish, subscribe), inbound and outbound message rates, an activity chart, and an inspect button for detailed channel access. | ||
|
|
||
| ### Channel inspection navigation <a id="channel-navigation"/> |
There was a problem hiding this comment.
This is another page with slightly grandiose claims. This is a whole section that essentially tells you to click a button to view the associated channel which could be a link to that page.
I think this is another page that's suffering in the same way as the product pages with trying to describe every little detail. Let me know your thoughts.
| If you have created apps already, your dashboard will look similar to the one shown in the following image. Each app displayed is a link to its specific dashboard, where you can view and configure settings, as well as monitor usage and statistics: | ||
|
|
||
| Manage your [billing](/docs/platform/pricing/billing) and package settings to scale your services: | ||
| ### Environments <a id="environment"/> |
There was a problem hiding this comment.
Where does this come from?
|
|
||
| Monitor your usage patterns and understand your account's capacity constraints to optimize performance, avoid service interruptions, and plan for future scaling needs. | ||
|
|
||
| The [Limits page](https://ably.com/accounts/any/account/limits) provides a comprehensive view of your account's usage limits and current consumption. Learn more about [account limits](/docs/platform/pricing/limits). It includes: |
There was a problem hiding this comment.
I feel this page has made the previous version overly complex. A lot of it just linked off to the pages that discussed that info (like limits and pricing), but we've tried to re-explain everything with all the interactions here.
GregHolmes
had a problem deploying
to
ably-docs-ftf-444-new-d-3u1mbl
- Add new dashboard screenshots across all product and configuration sections - Convert image paths to proper Markdown image links with descriptive alt text - Restructure account documentation by moving apps content to account index - Rename "organizations" to "team" throughout navigation and content - Update navigation configuration to reflect structural changes - Add comprehensive dashboard links and documentation cross-references - Enhance user experience with consistent image display formatting 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Remove 15 unused dashboard screenshot images to clean up the repository: - accounts.png, api-log-requests.png, apps.png, channels-inspector.png - create-app.png, dash-tabs.png, live stats.png, live-stats.png - organization.png, reports.png, rooms-inspector.png, spaces.png - stats-chart.png, stats-table.png, your-apps.png These images were added but are not referenced in any documentation files. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
GregHolmes
force-pushed
the
FTF-444-new-dashboard-docs
branch
from
a6436dc to
da97ce6
Compare
4 participants
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.