diff --git a/docs/developing/gh_clone.png b/docs/developing/gh_clone.png deleted file mode 100644 index a654aadf29..0000000000 Binary files a/docs/developing/gh_clone.png and /dev/null differ diff --git a/docs/developing/gh_fork.png b/docs/developing/gh_fork.png deleted file mode 100644 index a765410b97..0000000000 Binary files a/docs/developing/gh_fork.png and /dev/null differ diff --git a/docs/developing/index.md b/docs/developing/index.md deleted file mode 100644 index b471d7e97d..0000000000 --- a/docs/developing/index.md +++ /dev/null @@ -1,45 +0,0 @@ -# Development setup (BETA) - -## Get Docker - -Development requires Docker desktop available for windows + and mac or Docker CE available for Linux. Visit (Docker)[https://www.docker.com/get-started] -for download instructions - -## Setup VS Code IDE - -VS Code provides a free IDE experience that is effective for daily development with SC4S. Visit (Microsoft)[https://code.visualstudio.com/docs/introvideos/basics] -to download and install for your platform (windows/mac/linux) - -## Fork and Clone the github repository - -Visit our repository at (Github)[https://github.com/splunk/splunk-connect-for-syslog] and "fork" our repository. This will allow you to make changes and submit pull requests. - -![How to Fork](gh_fork.png) - -Click the clone icon and select the location - -![How to Clone](gh_clone.png) - -## Setup the project and install requirements - -The following steps are required _only_ on the first time run. - -* Install VS Code Extensions S - * Python - * Test Explorer - * "Python Test Explorer" -* From the terminal menu select "Run Task" -* Select "Setup step 1: python venv" then "go without scanning output" -* From the terminal menu select "Run Task" -* Select "Setup step 2: python requirements" then "go without scanning output" - -![VS Code setup](vsc_run.png) - -## Click the test lab icon - -* Run all tests. Icons on each test will turn green or red to indicate pass or fail. Though VS Code does not show the status -of any given test until all tests complete in the test tree, you can select "Show test output" near the top of the test -directory tree to see the terminal output of each test as it runs in the "Output" pane. - -![VS Code Debug](vsc_debug.png) - diff --git a/docs/developing/vsc_debug.png b/docs/developing/vsc_debug.png deleted file mode 100644 index e3950d4dd5..0000000000 Binary files a/docs/developing/vsc_debug.png and /dev/null differ diff --git a/docs/developing/vsc_run.png b/docs/developing/vsc_run.png deleted file mode 100644 index a00fef184f..0000000000 Binary files a/docs/developing/vsc_run.png and /dev/null differ diff --git a/docs/gettingstarted/create-parser.md b/docs/gettingstarted/create-parser.md index 22663ce455..b961080220 100644 --- a/docs/gettingstarted/create-parser.md +++ b/docs/gettingstarted/create-parser.md @@ -9,7 +9,22 @@ linebreaking, source/sourcetype setting, and timestamping. Creating a parser als ## Before you start * Make sure you have read [contribution standards](../CONTRIBUTING.md). * For more background information on how filters and parser work, and what suits you best, read about [sources onboarding](../sources/index.md). -* Prepare your [environment](../developing/index.md). +* Prepare your testing environment. With Python>=3.9: +``` +pip3 install poetry +poetry install +``` +* Prepare your testing command: +``` +poetry run pytest -v --tb=long \ +--splunk_type=external \ +--splunk_hec_token= \ +--splunk_host= \ +--sc4s_host= \ +--junitxml=test-results/test.xml \ +-n \ + +``` * Create a new branch in the repository where you will apply your changes. diff --git a/mkdocs-rtd.yml b/mkdocs-rtd.yml index 08cffb218b..8efec3b991 100644 --- a/mkdocs-rtd.yml +++ b/mkdocs-rtd.yml @@ -4,7 +4,6 @@ plugins: - redirects: redirect_maps: "architecture.md": "https://splunk.github.io/splunk-connect-for-syslog" - "developing/index.md": "https://splunk.github.io/splunk-connect-for-syslog" "faq.md": "https://splunk.github.io/splunk-connect-for-syslog" "troubleshooting/troubleshoot_SC4S_server.md": "https://splunk.github.io/splunk-connect-for-syslog" "troubleshooting/troubleshoot_resources.md": "https://splunk.github.io/splunk-connect-for-syslog" diff --git a/mkdocs.yml b/mkdocs.yml index 187e6cff8d..a7d5629e19 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -54,7 +54,6 @@ nav: - mk8s: "gettingstarted/ansible-mk8s.md" - Create a parser: "gettingstarted/create-parser.md" - Configuration: "configuration.md" - - Development: "developing/index.md" - Destinations: "destinations.md" - Sources: - Read First: "sources/index.md"