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.

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

[docs] Documentation restructure #1428

Merged
merged 11 commits into from
Oct 8, 2019
Merged

[docs] Documentation restructure #1428

merged 11 commits into from
Oct 8, 2019

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Oct 2, 2019 •
edited
Loading

WIP. For #1427.

This PR accomplishes the following:

New layout (only one link changes)
Screen Shot 2019-10-02 at 1 40 36 PM

@bmorelli25 bmorelli25 added the docs label Oct 2, 2019
@bmorelli25 bmorelli25 self-assigned this Oct 2, 2019
@nehaduggal nehaduggal mentioned this pull request Oct 2, 2019
Closed
bmorelli25
bmorelli25 commented Oct 2, 2019
View reviewed changes
docs/intro.asciidoc Outdated Show resolved Hide resolved
Qard
Qard reviewed Oct 2, 2019
View reviewed changes
Copy link
Contributor

@Qard Qard left a comment

Choose a reason for hiding this comment

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

Just left some quick suggestions for the intro doc, since you asked for it. I haven't done a full review. Let me know when you want one.

docs/intro.asciidoc Outdated Show resolved Hide resolved
docs/intro.asciidoc Outdated Show resolved Hide resolved
@bmorelli25
Copy link
Member Author

Fantastic, thank you! Still some work to do, so I probably won't open this up for a full review until tomorrow. I'll let you know!

@bmorelli25 bmorelli25 mentioned this pull request Oct 2, 2019
Closed
8 tasks
@bmorelli25 bmorelli25 marked this pull request as ready for review October 3, 2019 19:12
bmorelli25
bmorelli25 commented Oct 7, 2019
View reviewed changes
Copy link
Member Author

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

@Qard this is ready for a final review

@bmorelli25
Copy link
Member Author

It looks like it doesn't like the commit naming from the GitHub suggestions: Update docs/intro.asciidoc. Do I need to rename those?

@Qard
Copy link
Contributor

Qard commented Oct 7, 2019

Yes, all commits need to follow the type(subsystem): message or type: message forms. I'd just squash the commits, but we can also do that when landing, assuming everything else passes.

@bmorelli25 bmorelli25 force-pushed the nodejs-doc-restructure branch 2 times, most recently from c835086 to 1e5f4ba Compare October 8, 2019 15:16
@bmorelli25
Copy link
Member Author

Finally got this green @Qard

Qard
Qard reviewed Oct 8, 2019
View reviewed changes
Copy link
Contributor

@Qard Qard left a comment

Choose a reason for hiding this comment

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

LGTM other than one formatting question. Also, I'd like to backport this to 2.x so we can minimize the delta between versions allowing future doc fixes to be backported easily too. Any issues you foresee with that?

docs/supported-technologies.asciidoc Show resolved Hide resolved
@bmorelli25
Copy link
Member Author

I agree with backporting these changes. I expect a few collisions, but don't see any major problems getting this backported.

@bmorelli25 bmorelli25 merged commit a429699 into elastic:master Oct 8, 2019
@bmorelli25 bmorelli25 deleted the nodejs-doc-restructure branch October 8, 2019 21:27
bmorelli25 added a commit to bmorelli25/apm-agent-nodejs that referenced this pull request Oct 8, 2019
@bmorelli25
docs: documentation restructure (elastic#1428)
96dfcf3
bmorelli25 added a commit to bmorelli25/apm-agent-nodejs that referenced this pull request Oct 8, 2019
@bmorelli25
docs: documentation restructure (elastic#1428)
9d94460 
# Conflicts:
#	docs/redirects.asciidoc
This was referenced Oct 8, 2019
Closed
Merged
bmorelli25 added a commit that referenced this pull request Oct 9, 2019
@bmorelli25
docs: documentation restructure (#1428) (#1443)
28f42b7
v1v pushed a commit to v1v/apm-agent-nodejs that referenced this pull request Oct 11, 2019
@bmorelli25 @v1v
docs: documentation restructure (elastic#1428)
7fc602f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Qard Qard Qard approved these changes

Assignees

@bmorelli25 bmorelli25

Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[docs] Fix duplication on getting started pages and api calls
2 participants
@bmorelli25 @Qard