docs: remove developing/index.md (#2464)

splunk · Jun 3, 2024 · ee79f29 · ee79f29
1 parent 889d78c
commit ee79f29
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 48 deletions.
diff --git a/docs/developing/gh_clone.png b/docs/developing/gh_clone.png
diff --git a/docs/developing/gh_fork.png b/docs/developing/gh_fork.png
diff --git a/docs/developing/index.md b/docs/developing/index.md
diff --git a/docs/developing/vsc_debug.png b/docs/developing/vsc_debug.png
diff --git a/docs/developing/vsc_run.png b/docs/developing/vsc_run.png
diff --git 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=<HEC_TOKEN> \
+--splunk_host=<HEC_ENDPOINT> \
+--sc4s_host=<SC4S_IP> \
+--junitxml=test-results/test.xml \
+-n <NUMBER_OF_JOBS> \
+<TEST>
+```
 * Create a new branch in the repository where you will apply your changes.
 
 

diff --git 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
@@ -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"