-
Notifications
You must be signed in to change notification settings - Fork 141
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
Updates to API template to meet docs standards #2389
Conversation
527be94
to
63f990a
Compare
/approve |
[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 |
63f990a
to
1ce33a2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
@abrennan89: The following test failed, say
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. |
1500005
into
openshift:master
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