Skip to content

Commit

Permalink
docs: add screenshots of the tool
Browse files Browse the repository at this point in the history
  • Loading branch information
Mcdostone committed Feb 6, 2025
1 parent b759217 commit 2b40a9a
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 14 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,26 @@ yozf -c localhost
- [Keybindings.](https://github.com/MAIF/yozefu/tree/main/docs/keybindings/README.md)
- [Releasing a new version.](https://github.com/MAIF/yozefu/tree/main/docs/release/README.md)



## Screenshots

<table>
<tr>
<td>
<img alt="A table listing topics and kafka records" src="./docs/screenshots/topics.png">
</td>
<td>
<img alt="A table listing kafka records" src="./docs/screenshots/records.png">
</td>
</tr>
<tr>
<td>
<img alt="View of a selected kafka records" src="./docs/screenshots/record.png">
</td>
<td>
<img alt="View of the help page" src="./docs/screenshots/help.png">
</td>
</tr>
</table>

32 changes: 18 additions & 14 deletions crates/command/examples/my_cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,24 @@ impl MyCli {
pub fn kafka_client_config(&self) -> ClusterConfig {
let mut config = ClientConfig::new();
config.set_log_level(rdkafka::config::RDKafkaLogLevel::Emerg);
match self.command.default_command.cluster() {
Cluster::Localhost => {
config.set("bootstrap.servers", "kafka-localhost.acme:9092".to_string())
}
Cluster::Test => config.set("bootstrap.servers", "kafka-test.acme:9092".to_string()),
Cluster::Development => config.set(
"bootstrap.servers",
"kafka-development.acme:9092".to_string(),
),
Cluster::Production => config.set(
"bootstrap.servers",
"kafka-production.acme:9092".to_string(),
),
};
if let Some(cluster) = self.command.cluster() {
match cluster {
Cluster::Localhost => {
config.set("bootstrap.servers", "kafka-localhost.acme:9092".to_string())
}
Cluster::Test => {
config.set("bootstrap.servers", "kafka-test.acme:9092".to_string())
}
Cluster::Development => config.set(
"bootstrap.servers",
"kafka-development.acme:9092".to_string(),
),
Cluster::Production => config.set(
"bootstrap.servers",
"kafka-production.acme:9092".to_string(),
),
};
}

ClusterConfig {
url_template: None,
Expand Down
Binary file added docs/screenshots/help.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 docs/screenshots/record.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 docs/screenshots/records.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 docs/screenshots/topics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2b40a9a

Please sign in to comment.