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 #4689

Closed
1 of 4 tasks
kolchfa-aws opened this issue Aug 3, 2023 · 4 comments
Closed
1 of 4 tasks

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

kolchfa-aws opened this issue Aug 3, 2023 · 4 comments
Assignees
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started good first issue Good for newcomers Sev3 Medium priority. Content that's missing, driven by dev, PM or the community.

Comments

@kolchfa-aws
Copy link
Collaborator

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
A lot of pages in the API reference section do not conform to our API template. They need to be reorganized in order to follow the template. This includes:

  • Reordering the sections so that they are in the correct order
  • Splitting the URL parameters table into two tables: Path parameters and Query parameters
  • 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.
  • Making any other necessary changes for the pages to conform to the API template.
@kolchfa-aws kolchfa-aws added untriaged good first issue Good for newcomers and removed untriaged labels Aug 3, 2023
@Naarcha-AWS Naarcha-AWS added Sev3 Medium priority. Content that's missing, driven by dev, PM or the community. 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Aug 8, 2023
@samipak458
Copy link
Contributor

@Naarcha-AWS I would like to work on this issue, kindly assign me.

@Naarcha-AWS
Copy link
Collaborator

@samipak458: Scope. I would start with any files that are more have no been modified in the past 4 months in the api_reference directory. https://github.com/opensearch-project/documentation-website/tree/main/_api-reference

@Naarcha-AWS
Copy link
Collaborator

Beyond formatting according to the template, I would also address the following:

  • 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.

@samipak458
Copy link
Contributor

Ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started good first issue Good for newcomers Sev3 Medium priority. Content that's missing, driven by dev, PM or the community.
Projects
None yet
Development

No branches or pull requests

3 participants