Navigation Menu

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

Jump to bottom

Consider changing "API Documentation" to "Documenting APIs" #2835

Closed
mbroz2 opened this issue Oct 14, 2020 · 4 comments
Closed

Consider changing "API Documentation" to "Documenting APIs" #2835

mbroz2 opened this issue Oct 14, 2020 · 4 comments
Assignees
@Charlotte-Holt
Labels
doc bug Something isn't working. strategist reviewed Laura or Alasdair reviewed and approved the documentation from a content strategy perspective.

Comments

@mbroz2
Copy link
Member

mbroz2 commented Oct 14, 2020 •
edited

@barecode mentioned in #840 that the "API Documentation" header made him expect to find the content/APIs that's currently under "References" section. I suggest we rename this section to instead be "Documenting APIs" to help make it clear that it's not about our documentation for our APIs, but rather documentation on how to document their APIs.
@Charlotte-Holt Charlotte-Holt added the doc bug Something isn't working. label Nov 3, 2020
@Charlotte-Holt Charlotte-Holt self-assigned this Nov 4, 2020
@Charlotte-Holt
Copy link
Contributor

Charlotte-Holt commented Nov 4, 2020 •
edited

@dmuelle @lauracowen I updated "API documentation" to "Documenting APIs" in the nav: https://draft-openlibertyio.mybluemix.net/docs/20.0.0.12/overview.html. Are you good with me going ahead and merging this change to staging and vNext?

@lauracowen
Copy link
Member

Yup!

@lauracowen lauracowen added the strategist reviewed Laura or Alasdair reviewed and approved the documentation from a content strategy perspective. label Nov 5, 2020
@barecode
Copy link
Contributor

barecode commented Nov 5, 2020

This looks great, thank you!

@Charlotte-Holt
Copy link
Contributor

This was merged to vNext in #3119. It'll publish with 20.0.0.12. Closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Charlotte-Holt Charlotte-Holt

Labels
doc bug Something isn't working. strategist reviewed Laura or Alasdair reviewed and approved the documentation from a content strategy perspective.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@barecode @mbroz2 @lauracowen @Charlotte-Holt