Group API and REST resources together or rename
Issue 1: Page/nav title inconsistency
I noticed that we have these two pages in the Documentation
section of the left nav (these are the last two pages in the entire nav):
- Which title is correct? The nav title:
RESTful API style guide
or the page title:Documenting REST API resources
?
Issue 2: Nav locations
- Should the
Create a GraphQL example page
be with the other GraphQL content (underGraphQL API style guide
)?
Issue 3: Deprecations
REST API deprecations are documented under Documentation
: https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#deprecations
GraphQL API deprecations are documented under Development style guides
: https://docs.gitlab.com/ee/development/api_graphql_styleguide.html#deprecating-schema-items
- Should the REST API page be under
Development style guides
? Or should the GraphQL API deprecation info be on its own page under theDocumentation
section of the nav?
Edited by Suzanne Selhorn