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

Cherry-pick #20917 to 7.9: Include python docs in devguide index #20922

Merged
merged 1 commit into from
Sep 2, 2020
Merged

Cherry-pick #20917 to 7.9: Include python docs in devguide index #20922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/devguide/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ include::./fields-yml.asciidoc[]

include::./event-conventions.asciidoc[]

include::./python.asciidoc[]

include::./newdashboards.asciidoc[]

include::./new_protocol.asciidoc[]
Expand Down
8 changes: 4 additions & 4 deletions docs/devguide/python.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[python-beats]]
== Python in Beats
=== Python in Beats

Python is used for Beats development, it is the language used to implement
system tests and some other tools. Python dependencies are managed by the use of
Expand All @@ -9,7 +9,7 @@ https://docs.python.org/3/library/venv.html[venv].
Beats development requires Python >= {python}.

[[installing-python]]
=== Installing Python and venv
==== Installing Python and venv

Python uses to be installed in many operating systems. If it is not installed in
your system you can follow the instructions available in https://www.python.org/downloads/
Expand All @@ -32,7 +32,7 @@ sudo apt-get install python3.7 python3.7-venv
It is recommended to use Python >= {python}.

[[python-virtual-environments]]
=== Working with virtual environments
==== Working with virtual environments

All `make` and `mage` targets manage their own virtual environments in a transparent
way, so for the most common operations required when contributing to beats,
Expand Down Expand Up @@ -65,7 +65,7 @@ To recreate a virtual environment, remove its directory. All virtual
environments are also removed with `make clean`.

[[python-older-versions]]
=== Working with older versions
==== Working with older versions

Older versions of Beats were not compatible with Python 3, if you need to
temporary work on one of these versions of Beats, and you don't want to remove
Expand Down