[improve][fn] add docs for supporting reading config options from files in Python runner

[Anonymitaet]

This PR adds docs for apache/pulsar#18951. It is based on the tech inputs provided by @tpiperatgod in #541

• doc

cc @D-2-Ed for editorial review, thanks!

[Anonymitaet]

Hi @tpiperatgod, I submit this PR since it's more convenient to show you my thoughts and preview.

Preview

Doc changes explanations

2️⃣3️⃣ in the image above
I've restricted the doc structure by "showing the example first" and then "explaining the details".

Reasons:

1. Most developers are likely "learning by doing" rather than "learning by reading". Examples always attract them the most. "Hook them up" first and then they have more patience to read it through.

2. The doc structure is more clear. The beginning is the example, and the latter is the explanation. Splitting them up can increase readability.

1️⃣

Consolidate the note into running text to accommodate the new structure.

I've also made other changes like updating all future tense to present tense since "Write in the simple present tense as much as possible if you are covering facts that were, are, and forever shall be true" is a rule in technical writing.

Question

4️⃣

Seems that the explanations in this box is contradictory.

The above indicates "--config-file" override "command-line", but the below says the opposite. Can you clarify a bit and give some examples? Thank you!

[tpiperatgod]

lgtm

And for question 4:

I made a mistake in the first sentence, it should be that the parameters passed in from the command line have a higher priority.

Thank you for the review and the advice on technical writing!

[Anonymitaet]

@tpiperatgod thanks for your quick response!

it should be that the parameters passed in from the command line have a higher priority.

Does that mean I can delete the 1st sentence and only keep the 2nd one?

[tpiperatgod]

Yes

[Anonymitaet]

Yes

Done, PTAL.

[Anonymitaet]

@momo-jun @Huanli-Meng could you please help review? Thank you!

[momo-jun]

LGTM in general, with a couple of suggestions.

[tisonkun]

site2/website-next/yarn.lock is checked in unintentionally. Reverting...

[Anonymitaet]

@tisonkun Oops! Thank you!