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

[DOC] Format all API pages according to the API template #1

Merged
merged 1 commit into from
Oct 6, 2023

Conversation

samipak458
Copy link
Owner

@samipak458 samipak458 commented Oct 6, 2023

Description

Fix API reference section according to API template.

  • Reordering the sections so that they are in the correct order.
  • Ensuring all field names and variables are in code font (surrounded by tick marks (`)).
  • Ensuring the headings are heading level 2 for the section names and level 4 for examples.
  • Make heading levels consistent across pages.
  • Make sure API names use the same capitalization.
  • Make sure that each page uses terminology that matches the template.

Issues Resolved

Closes Issue opensearch-project#4689

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: samipak458 <[email protected]>
@samipak458 samipak458 merged commit 185c4a5 into main Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant