Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Fix network-related docs for API v1alpha7 #1764

Merged

Conversation

stephenfin
Copy link
Contributor

What this PR does / why we need it:

Update the docs to reflects changes introduced in API v1alpha7. While here we also fix some other issues with the docs and bump the version of mkdocs.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):

n/a

Special notes for your reviewer:

n/a

TODOs:

  • squashed commits
  • if necessary:
    • includes documentation
    • adds unit tests

/hold

0.4.5 is ancient. Use the latest and greatest version.

Signed-off-by: Stephen Finucane <[email protected]>
Our examples indicated:

  apiVersion: infrastructure.cluster.x-k8s.io/v1alpha7
  kind: OpenStackMachineTemplate
  ...
  spec:
    foo:
      ...

when in fact it should read:

  apiVersion: infrastructure.cluster.x-k8s.io/v1alpha7
  kind: OpenStackMachineTemplate
  ...
  spec:
    template:
      spec:
        foo:
          ...

Correct this oversight.

Signed-off-by: Stephen Finucane <[email protected]>
The 'network' filter has been removed in API v1alpha7. Update our docs
to reflect this.

Signed-off-by: Stephen Finucane <[email protected]>
@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 29, 2023
Copy link

netlify bot commented Nov 29, 2023

Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!

Name Link
🔨 Latest commit fc76995
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-cluster-api-openstack/deploys/65676313225486000876bac0
😎 Deploy Preview https://deploy-preview-1764--kubernetes-sigs-cluster-api-openstack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 29, 2023
@stephenfin
Copy link
Contributor Author

/retitle 📖 Fix network-related docs for API v1alpha7

@k8s-ci-robot k8s-ci-robot changed the title Fix network-related docs for API v1alpha7 📖 Fix network-related docs for API v1alpha7 Nov 29, 2023
@stephenfin
Copy link
Contributor Author

/assign @mdbooth

Copy link
Contributor

@lentzi90 lentzi90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 30, 2023
@jichenjc
Copy link
Contributor

/approve

thanks for the update

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jichenjc, stephenfin

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 30, 2023
@mdbooth
Copy link
Contributor

mdbooth commented Nov 30, 2023

/lgtm thanks!

@jichenjc
Copy link
Contributor

jichenjc commented Dec 1, 2023

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 1, 2023
@k8s-ci-robot k8s-ci-robot merged commit 8a49b9f into kubernetes-sigs:main Dec 1, 2023
3 checks passed
@stephenfin stephenfin deleted the network-example-doc-fixes branch December 1, 2023 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants