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

Move dev guide topics to separate guide #4030

Merged
merged 1 commit into from
Apr 19, 2017

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Apr 18, 2017

This PR moves all the dev guide content into a separate book.

This is the first phase (getting everything into a separate book). See #3738.

Other related work that's remaining:

  • Move content from CONTRIBUTING.md into the dev guide.
  • Move the devguide to beats/docs instead of beats/libbeat/docs
  • Update conf.yaml to include the dev guide. Also make sure any paths outside of the docs dir are accounted for (a PR with the conf.yaml change needs to be merged at the same time as this PR).
  • Fix any links in other doc that point to the moved topics
  • Add topic about contributing to Beats that points from the doc for each beat to the Dev Guide.

Moved this list of remaining work to this issue: #4059

@dedemorton dedemorton added docs in progress Pull request is currently in progress. labels Apr 18, 2017
@dedemorton
Copy link
Contributor Author

dedemorton commented Apr 19, 2017

Here's what the TOC looks like with the changes. I plan to add more content and improve the structure, but first I wanted to get everything moved into a separate book (with minimal content changes). In the dev guide, the "Contributing to Beats" topic is the content taken from CONTRIBUTING.md.

image

Each of reference guides has a topic called "Contributing to Beats" but it's just a short topic to point users to the Dev Guide. I want to make sure we're covered for users who are accustomed to seeing the dev topics in the reference guides.

image

@monicasarbu
Copy link
Contributor

@dedemorton Great work! I am ok with merging as it is.

Copy link
Member

@ruflin ruflin left a comment

Choose a reason for hiding this comment

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

LGTM

@ruflin
Copy link
Member

ruflin commented Apr 19, 2017

jenkins, retest it

@dedemorton dedemorton merged commit 3500ae7 into elastic:master Apr 19, 2017
@dedemorton dedemorton added v6.0.0-alpha1 and removed in progress Pull request is currently in progress. labels Apr 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants