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

[DOCS] Change 'X-Pack APIs' section to 'REST APIs' #43451

Merged
merged 5 commits into from
Jun 26, 2019
Merged

[DOCS] Change 'X-Pack APIs' section to 'REST APIs' #43451

merged 5 commits into from
Jun 26, 2019

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Jun 20, 2019

Context

Creates a new general purpose 'REST APIs' section. The goal is to eventually separate and relocate all API reference documentation to this section.

Changes

  • Changes the title, anchor, and description of the X-Pack APIs page to reflect a general REST APIs section.

  • Relocates the REST APIs section to lower in the navigation.

@lcawl I removed the [role="xpack"] macro as part of this. Let me know if that's alright with you. I believe including that at the API level should be okay.

Before

Nav - Before Nav Before
REST API Overview - Before REST API Overview Before

After

Nav - After Nav After
REST API Overview - After REST API Overview After

Related Issues

Relates to elastic/docs#937.

@jrodewig jrodewig added >docs General docs changes :Core/Infra/Plugins Plugin API and infrastructure :Core/Infra/REST API REST infrastructure and utilities v8.0.0 labels Jun 20, 2019
@jrodewig jrodewig requested review from debadair and lcawl June 20, 2019 19:29
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

@jrodewig jrodewig added :Docs and removed :Core/Infra/Plugins Plugin API and infrastructure :Core/Infra/REST API REST infrastructure and utilities labels Jun 20, 2019
@lcawl
Copy link
Contributor

lcawl commented Jun 20, 2019

I will do a full rebuild to ensure this URL change doesn't cause any broken links. If it does, we can just add a deleted page, so that's no big deal.

@jrodewig
Copy link
Contributor Author

Thanks @lcawl. I went ahead and added a redirect with e08ae7f in case anyone has that page bookmarked, etc.

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and builds successfully

@jrodewig jrodewig changed the title [DOCS] Change 'X-Pack APIs' section to 'RESTful APIs' [DOCS] Change 'X-Pack APIs' section to 'REST APIs' Jun 21, 2019
@jrodewig
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/1

@jrodewig jrodewig added the WIP label Jun 21, 2019
@jrodewig jrodewig added v7.3.0 and removed WIP labels Jun 25, 2019
@jrodewig jrodewig merged commit 1594892 into elastic:master Jun 26, 2019
@jrodewig jrodewig deleted the create-restful-api-section branch June 26, 2019 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants