docs: add YAML as examples

[FoSix]

Description

Add YAML formatted examples next to Python code

Motivation and Context

see #97

How Has This Been Tested?

Tested on a local pan.dev build

Screenshots (if appropriate)

Types of changes

Checklist

• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes if appropriate.
• All new and existing tests passed.

[github-actions]

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
780	775	99%	95%	🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: f237cdc by action🐍

[github-actions]

A Preview PR in PanDev repo has been created. You can view it here.

[alperenkose]

It looks good. I'm thinking if we shall also include a reference to the pan-os ansible collection, otherwise it might not make sense for the users why yaml examples are provided.

[FoSix]

It looks good. I'm thinking if we shall also include a reference to the pan-os ansible collection, otherwise it might not make sense for the users why yaml examples are provided.

Yes, but the question is where. We have this text. Maybe somewhere here?

On the other hand, we already have this

[alperenkose]

Yes, but the question is where. We have this text. Maybe somewhere here?

On the other hand, we already have this

Exactly, I think we can add it following that line on the main page, sth like below perhaps?

They depend on pan-os-python libraries and therefore are quite easy to fit into the PanOS Ansible modules collection. Equivalent yaml configurations are provided in the documentation as a reference to use with the PanOS Ansible modules collection.

[FoSix]

Yes, but the question is where. We have this text. Maybe somewhere here?
On the other hand, we already have this

Exactly, I think we can add it following that line on the main page, sth like below perhaps?

They depend on pan-os-python libraries and therefore are quite easy to fit into the PanOS Ansible modules collection. Equivalent yaml configurations are provided in the documentation as a reference to use with the PanOS Ansible modules collection.

I've added that line.