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

Updates to API template to meet docs standards #2389

Merged
merged 2 commits into from
Mar 8, 2024

Conversation

abrennan89
Copy link
Contributor

@abrennan89 abrennan89 commented Mar 7, 2024

Description

This PR is to update the API doc templates to help remove roadblocks to publishing our documentation in the OCP docs set.
I have updated things like headings, metadata, and formatting for now as a first step to minimize additional work for tech writers, but there is more to do and will likely require additional follow up PRs.

This change should also be updated in older branches, but I can do that manually and regenerate the API docs as I go, rather than auto-CPing.

/cc @alanconway
/assign @jcantrill

Links

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 7, 2024
@openshift-ci openshift-ci bot requested a review from alanconway March 7, 2024 15:33
@jcantrill
Copy link
Contributor

/approve

Copy link
Contributor

openshift-ci bot commented Mar 7, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abrennan89, jcantrill

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 7, 2024
@abrennan89 abrennan89 changed the title [WIP] Updates to API template to meet docs standards Updates to API template to meet docs standards Mar 8, 2024
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 8, 2024
Copy link
Contributor

@jcantrill jcantrill left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 8, 2024
Copy link
Contributor

openshift-ci bot commented Mar 8, 2024

@abrennan89: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/functional 1ce33a2 link false /test functional

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

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. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants