API Quickstart doc

[jasonmadigan]

API quickstart doc.

WIP at the moment.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jasonmadigan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [jasonmadigan]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[jasonmadigan]

/hold

[david-martin]

@jasonmadigan
Trying this out locally, it doesn't like the private repo:

mkdocs_multirepo_plugin.util.BashException:
Cloning into 'api-quickstart'...
remote: Support for password authentication was removed on August 13, 2021.
remote: Please see https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.
fatal: Authentication failed for 'https://github.com/kuadrant/api-quickstart/'

Should we move the repo to public, or switch to an ssh url so key auth is used?

[jasonmadigan]

@david-martin this should work locally now.

[david-martin]

The wiring up works locally.
The document looks to render correctly, though I haven't gone through it fully.
Once this is merged, is there an extra step to deploy, or is the README from main of api-quickstart deployed there and then?
Should we hold off merge until the current round of testing and updates finish?

[jasonmadigan]

@david-martin yes I think this should remain on hold for a while more.

[jasonmadigan]

@R-Lawton @david-martin merged