Skip to content

Commit

Permalink
chore: update tokio-console screenshots for v0.1.13
Browse files Browse the repository at this point in the history
The screenshots on the docs.rs page for tokio-console are a bit out of
date. They are from v0.1.8 and still show the Target column instead of
the Kind column.

With the task size instrumentation and new lints which will be released
in the next version of Tokio Console, we need screenshots which match
what the user will see. The same goes for the screenshots in the
repository root README.md, which anyone visiting the repo page on GitHub
will see.

This change adds new screenshots for docs.rs and replaces the README
screenshots. We have to keep the docs.rs images from previous versions
still, since docs.rs pages for previous versions still reference them.

Additionally, a new CI job to build the docs.rs documentation and also
to check that all the images referenced from the tokio-console README
file (which is used on docs.rs) are present in the repository, as we
can't inspect the documentation until the change is merged.
  • Loading branch information
hds committed Oct 22, 2024
1 parent f4ee0df commit a747a6b
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 5 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,40 @@ jobs:
- name: Run cargo clippy
run: cargo clippy --workspace --all-targets --no-deps -- -D warnings

docs:
name: Docs
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4

- name: Install stable toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
- uses: Swatinem/rust-cache@v2

- name: Docs.rs
env:
RUSTDOCFLAGS: >
-D warnings
--force-warn rustdoc::redundant-explicit-links
--force-warn renamed-and-removed-lints
--cfg docsrs
--cfg tokio_unstable
RUSTFLAGS: --cfg tokio_unstable
run: cargo doc --no-deps --all-features

run:
- name: Check tokio-console README images
run: >
for filename in
$(grep 'https://raw.githubusercontent.com/tokio-rs/console/main/assets' tokio-console/ README.md
| perl -n -e '/(tokio-console-[\d\.]+\/\w+\.png)/; print "$1\n"'
); do
ls -l assets/$filename;
done
grpc_web:
name: gRPC-web Example
runs-on: ubuntu-latest
Expand Down
Binary file modified assets/readme/task-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/readme/top-for-tasks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/tokio-console-0.1.13/resources_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/tokio-console-0.1.13/task_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/tokio-console-0.1.13/tasks_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions tokio-console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ tokio-console --lang en_US.UTF-8
When the console CLI is launched, it displays a list of all [asynchronous tasks]
in the program:

![tasks list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/tasks_list.png)
![tasks list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/tasks_list.png)

Tasks are displayed in a table.

Expand Down Expand Up @@ -154,7 +154,7 @@ task.

This view shows details about a specific task:

![task details](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/task_details.png)
![task details](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/task_details.png)

The task details view includes percentiles and a visual histogram of the polling (busy) times
and scheduled times.
Expand All @@ -166,7 +166,7 @@ Pressing the <kbd>escape</kbd> key returns to the task list.
The <kbd>r</kbd> key switches from the list of tasks to a list of [resources],
such as synchronization primitives, I/O resources, et cetera:

![resource list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/resources_list.png)
![resource list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/resources_list.png)

Resources are displayed in a table similar to the task list.

Expand All @@ -192,13 +192,13 @@ while a resource is highlighted displays details about that resource.

### Resource Details

![resource details --- sleep](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/resource_details_sleep.png)
![resource details --- sleep](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/resource_details_sleep.png)

The resource details view lists the tasks currently waiting on that resource.
This may be a single task, as in the [`tokio::time::Sleep`] above, or
a large number of tasks, such as this private `tokio::sync::batch_semaphore::Semaphore`:

![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/resource_details_semaphore.png)
![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/resource_details_semaphore.png)

The resource details view includes a table of async ops belonging to the resource.

Expand Down

0 comments on commit a747a6b

Please sign in to comment.