Skip to content

[docs] Standardize API reference #975

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.

Sign up for GitHub

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
Merged
merged 5 commits into from
Apr 9, 2019
Merged

[docs] Standardize API reference #975

merged 5 commits into from
Apr 9, 2019

Conversation

bmorelli25
Copy link
Member

Here's a WIP PR that fixes #925. Still lots to clean up, but wanted to get this up.

@bmorelli25 bmorelli25 added the docs label Apr 2, 2019
@bmorelli25 bmorelli25 self-assigned this Apr 2, 2019
Qard
Qard previously approved these changes Apr 3, 2019
View reviewed changes
@bmorelli25 bmorelli25 marked this pull request as ready for review April 8, 2019 22:39
@bmorelli25 bmorelli25 force-pushed the standardize-api-docs branch from c513f6b to 8b9d762 Compare April 8, 2019 22:40
@bmorelli25
Copy link
Member Author

Sorry this took so long, I got sucked into release projects. I was able to add a lot of the added dates, but others were complicated or too time consuming to find.

watson
watson reviewed Apr 9, 2019
View reviewed changes
Copy link
Contributor

@watson watson left a comment

Choose a reason for hiding this comment

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

No worries. This wasn't time critical, just something that had been bugging me for a while, so it was really great that you took the time to take on this one. It's really appreciated and I think this will benefit end users in many was also!

I just tried to render this locally and as I had expected/feared, some of the headlines are so long now that the right-hand menu contains line breaks. This is not a deal breaker, but I was just wondering what your thoughts were on it?

image

watson
watson reviewed Apr 9, 2019
View reviewed changes
Copy link
Contributor

@watson watson left a comment

Choose a reason for hiding this comment

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

Ups I missed two things. Should be all reviewed now :)

@bmorelli25
Copy link
Member Author

bmorelli25 commented Apr 9, 2019 •
edited
Loading

Thanks for catching a few of those missed substitutions!

RE: long headlines - Yeah, this was one of my concerns as well. I was actually pleasantly surprised to see it only happens three times at most screen resolutions on my computer (2x agent API, 1x transaction API). Unfortunately, we really have no perfect solution for API documentation right now. There are going to be compromises, and this is such a minor compromise for such a big improvement 🤷‍♂️I'm okay with it

@watson
Copy link
Contributor

watson commented Apr 9, 2019

We'll just ignore the commit message lint error. I'll fix it when I merge

@watson watson requested a review from Qard April 9, 2019 20:12
@watson watson merged commit 9e912b7 into elastic:master Apr 9, 2019
@bmorelli25 bmorelli25 deleted the standardize-api-docs branch April 9, 2019 22:36
@watson watson mentioned this pull request Jun 17, 2019
Open
@bmorelli25 bmorelli25 mentioned this pull request Apr 23, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@watson watson watson approved these changes

@Qard Qard Qard approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@bmorelli25 bmorelli25

Labels

docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Standardize API docs

3 participants

@bmorelli25 @watson @Qard