github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs(NA): drop windows native development support (#135964)

Browse source 
* docs(NA): drop support for windows native development

* docs(NA): improve previous written instructions around windows de

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Tiago Costa 2022-07-21 14:37:18 +01:00 • committed by GitHub
parent aec761efbe
commit 7cc4eaee28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

15
dev_docs/getting_started/setting_up_a_development_env.mdx
View file

@ -3,22 +3,15 @@ id: kibDevTutorialSetupDevEnv
slug: /kibana-dev-docs/getting-started/setup-dev-env
title: Set up a Development Environment
summary: Learn how to setup a development environment for contributing to the Kibana repository
date: 2021-04-26
date: 2022-07-07
tags: ['kibana', 'onboarding', 'dev', 'architecture', 'setup']
---
Setting up a development environment is pretty easy.
<DocCallOut title="A note about Windows">
In order to support Windows development we currently require you to use one of the following:
- [Git Bash](https://git-scm.com/download/win)
- [Windows Subsystem for Linux (recommended)](https://docs.microsoft.com/en-us/windows/wsl/about)
If you want to know more about how to setup and use WSL for development on Windows, which will become our only supported way in the upcoming future, please check our <DocLink id="kibDevTutorialSetupWindowsDevWSL" text="tutorial"/>.
Before running the steps below, please make sure you have installed [Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145) and that you are running all commands in either Git Bash or WSL.
We do not support Windows native development anymore and in order to develop Kibana on Windows you must use **WSL** which will give you a much better experience.
Please check our <DocLink id="kibDevTutorialSetupWindowsDevWSL" text="tutorial"/> to know how to setup the environment and then follow the rest of this guide inside **WSL**.
</DocCallOut>
## Get the code
@ -34,7 +27,7 @@ cd kibana
## Install dependencies
Install the version of Node.js listed in the `.node-version` file. This can be automated with tools such as [nvm](https://github.com/creationix/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows). As we also include a `.nvmrc` file you can switch to the correct version when using nvm by running:
Install the version of Node.js listed in the `.node-version` file. This can be automated with tools such as [nvm](https://github.com/creationix/nvm). As we also include a `.nvmrc` file you can switch to the correct version when using nvm by running:
```sh
nvm use

5
dev_docs/tutorials/development_windows.mdx
View file

@ -3,14 +3,15 @@ id: kibDevTutorialSetupWindowsDevWSL
slug: /kibana-dev-docs/tutorial/setup-windows-development-wsl
title: WSL on Windows Development
summary: Learn how to setup a Windows development environment using WSL
date: 2022-06-16
date: 2022-07-07
tags: ['kibana', 'onboarding', 'setup', 'windows', 'development', 'wsl']
---
# Overview
Development on Windows is recommended through WSL2. WSL lets users run a Linux environment on Windows, providing a supported development environment for Kibana.
Development on Windows is only supported through WSL2. WSL lets users run a Linux environment on Windows, providing a supported development environment for Kibana with a much better experience and
performance than the native one.
<DocCallOut title="Prerequisites">

22
docs/developer/getting-started/index.asciidoc
View file

@ -7,21 +7,10 @@ Get started building your own plugins, or contributing directly to the {kib} rep
[[developing-on-windows]]
=== Developing on Windows
In order to support Windows development we currently require you to use one of the following:
- https://git-scm.com/download/win[Git bash] (other bash emulators like https://cmder.net/[Cmder] could work but we did not test them)
- https://docs.microsoft.com/en-us/windows/wsl/about[WSL]
As well as installing https://www.microsoft.com/en-us/download/details.aspx?id=48145[Visual C++ Redistributable for Visual Studio 2015].
In addition we also require you to do the following:
- Install https://www.microsoft.com/en-us/download/details.aspx?id=48145[Visual C++ Redistributable for Visual Studio 2015]
- Enable the https://docs.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development[Windows Developer Mode]
- Enable https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/fsutil-8dot3name[8.3 filename support] by running the following command in a windows command prompt with admin rights `fsutil 8dot3name set 0`
Before running the steps listed below, please make sure you have installed everything
that we require and listed above and that you are running all the commands from now on through Git bash or WSL.
We do not support Windows native development anymore and in order to develop Kibana on Windows please https://docs.microsoft.com/en-us/windows/wsl/setup/environment[setup a WSL environment] which will
give you a much better experience.
In addition to that you will also benefit from https://docs.microsoft.com/en-us/windows/wsl/tutorials/gui-apps[run GUI apps on WSL] like Chrome for test and debug purposes.
Once completed, follow the rest of this guide inside the WSL.
[discrete]
[[get-kibana-code]]
@ -40,8 +29,7 @@ cd kibana
Install the version of Node.js listed in the `.node-version` file. This
can be automated with tools such as
https://github.com/nvm-sh/nvm[nvm],
https://github.com/coreybutler/nvm-windows[nvm-windows] or
https://github.com/nvm-sh/nvm[nvm] or
https://github.com/wbyoung/avn[avn]. As we also include a `.nvmrc` file
you can switch to the correct version when using nvm by running: