docs: explain how to create an onboarding workflow for an extension (#3440)

[lstocchi]

What does this PR do?

It adds the documentation to show how to add an onboarding workflow to an extension

Screenshot/screencast of this PR

N/A

What issues does this PR fix or reference?

it resolves #3440

How to test this PR?

N/A

[benoitf]

always nice to have documentation 🎉

[feloy]

Thanks for this documentation 💯

[deboer-tim]

Some minor changes suggested, also need to deal with the PR check errors.

[cdrage]

Other than the small Vale error this looks great!

[lstocchi]

@themr0c do you know why vale is erroring? When i run vale locally it doesn't find any errors, so i don't get the failing gh action workflow here. What do i have to do to fix it? Thanks!!

[deboer-tim]

Thanks for the changes, LGTM. Please figure out how to resolve Vale error before merging though.

For the record N.B. is correct in English too, just not very common and potentially confusing in Canada. ;-)

[feloy]

Did you try to use absolute paths for links? There are many errors like this one, can this be cause of vale erroring?

Raw Output:
  {"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "website/docs/extensions/write/onboarding-workflow.md", "range": {"start": {"line": 378, "column": 151}}}, "severity": "WARNING"}
  Warning: [vale] reported by reviewdog 🐶
  [PodmanDesktop.Links] Consider starting the link with https:// or /, rather than ](img/button_micromark.png)

[benoitf]

Here it's a vale check error on links 🤦‍♀️

[lstocchi]

Did you try to use absolute paths for links? There are many errors like this one, can this be cause of vale erroring?

Raw Output:
  {"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "website/docs/extensions/write/onboarding-workflow.md", "range": {"start": {"line": 378, "column": 151}}}, "severity": "WARNING"}
  Warning: [vale] reported by reviewdog 🐶
  [PodmanDesktop.Links] Consider starting the link with https:// or /, rather than ](img/button_micromark.png)

the weird thing is that in all other pages with images this is how links are. So i just copied/paste it. Now i tried to add the /, let's see if it becomes green

[feloy]

Did you try to use absolute paths for links? There are many errors like this one, can this be cause of vale erroring?

Raw Output:
  {"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "website/docs/extensions/write/onboarding-workflow.md", "range": {"start": {"line": 378, "column": 151}}}, "severity": "WARNING"}
  Warning: [vale] reported by reviewdog 🐶
  [PodmanDesktop.Links] Consider starting the link with https:// or /, rather than ](img/button_micromark.png)

the weird thing is that in all other pages with images this is how links are. So i just copied/paste it. Now i tried to add the /, let's see if it becomes green

I remember a message saying in the log: "error: too many warnings".

The links you had added probably exceeded the threshold

[lstocchi]

I remember a message saying in the log: "error: too many warnings".

The links you had added probably exceeded the threshold

no idea what was the problem. bc there was specified a limit of 10 and i was sure i only had 10 warnings. Maybe there was something else 🤷‍♂️ btw thanks @feloy , it worked 👍