Skip to content

Quickstart document should use pingora v0.3 #432

@gth828r

Description

@gth828r

Describe the bug

The quickstart tutorial includes a step near the end for adding built-in argument parsing functionality in the server. The interface used for this was not introduced until the v0.3.0 release from what I can tell, but the current quickstart document suggests using the v0.1.0 release.

Pingora info

Pingora version: v0.1.0
Rust version: cargo 1.82.0-nightly
Operating system version: Ubuntu 22.04

Steps to reproduce

Follow the quickstart tutorial at https://github.com/cloudflare/pingora/blob/main/docs/quick_start.md verbatim until you reach https://github.com/cloudflare/pingora/blob/main/docs/quick_start.md#command-line-options. Upon adding those lines, the compiler is unable to detect the Opt::parse_args interface.

Expected results

Expected to walk through each step of the tutorial and run it.

Observed results

When using the existing documentation, the program doesn't compile part-way through the quickstart tutorial.

Additional context

None

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions