chore: use docs-dev instead of docs folder

Author: traut

detection_rules/custom_rules.py

@@ -11,11 +11,12 @@
 
 from .main import root
 from .utils import get_etc_path, load_etc_dump, ROOT_DIR
+from .docs import DOCS_DIR
 
 from semver import Version
 
 DEFAULT_CONFIG_PATH = Path(get_etc_path('_config.yaml'))
-CUSTOM_RULES_DOC_PATH = Path(ROOT_DIR).joinpath('docs', 'custom-rules.md')
+CUSTOM_RULES_DOC_PATH = Path(ROOT_DIR).joinpath(DOCS_DIR, 'custom-rules.md')
 
 
 @root.group('custom-rules')

detection_rules/devtools.py

@@ -34,7 +34,7 @@
                     refresh_main_schema)
 from .cli_utils import single_collection
 from .config import parse_rules_config
-from .docs import IntegrationSecurityDocs, IntegrationSecurityDocsMDX
+from .docs import IntegrationSecurityDocs, IntegrationSecurityDocsMDX, DOCS_DIR
 from .ecs import download_endpoint_schemas, download_schemas
 from .endgame import EndgameSchemaManager
 from .eswrap import CollectEvents, add_range_to_dsl
@@ -566,7 +566,7 @@ def elastic_pkg(*args):
 
     ## Checklist
 
-    - [x] I have reviewed [tips for building integrations](https://github.com/elastic/integrations/blob/master/docs/tips_for_building_integrations.md) and this pull request is aligned with them.
+    - [x] I have reviewed [tips for building integrations](https://github.com/elastic/integrations/blob/master/docs-dev/tips_for_building_integrations.md) and this pull request is aligned with them.
     - [ ] ~I have verified that all data streams collect metrics or logs.~
     - [x] I have added an entry to my package's `changelog.yml` file.
     - [x] If I'm introducing a new feature, I have modified the Kibana version constraint in my package's `manifest.yml` file to point to the latest Elastic stack release (e.g. `^7.13.0`).
@@ -802,7 +802,7 @@ def deprecate_rule(ctx: click.Context, rule_file: Path, deprecation_folder: Path
               help='GitHub token to push to gist', hide_input=True)
 @click.option('--gist-id', default=NAVIGATOR_GIST_ID, help='Gist ID to be updated (must exist).')
 @click.option('--print-markdown', is_flag=True, help='Print the generated urls')
-@click.option('--update-coverage', is_flag=True, help='Update the docs/ATT&CK-coverage.md file')
+@click.option('--update-coverage', is_flag=True, help='Update the docs-dev/ATT&CK-coverage.md file')
 def update_navigator_gists(directory: Path, token: str, gist_id: str, print_markdown: bool,
                            update_coverage: bool) -> list:
     """Update the gists with new navigator files."""
@@ -857,7 +857,7 @@ def raw_permalink(raw_link):
         click.echo('\n'.join(markdown) + '\n')
 
     if update_coverage:
-        coverage_file_path = get_path('docs', 'ATT&CK-coverage.md')
+        coverage_file_path = get_path(DOCS_DIR, 'ATT&CK-coverage.md')
         header_lines = textwrap.dedent("""# Rule coverage
 
 ATT&CK navigator layer files are generated when a package is built with `make release` or

detection_rules/docs.py

@@ -24,6 +24,8 @@
 from .rule_loader import DeprecatedCollection, RuleCollection
 from .utils import load_etc_dump, save_etc_dump
 
+DOCS_DIR = "docs-dev"
+
 
 class PackageDocument(xlsxwriter.Workbook):
     """Excel document for summarizing a rules package."""
@@ -278,8 +280,8 @@ def __init__(self, registry_version: str, directory: Path, overwrite=False,
         self.sorted_rules = sorted(all_rules, key=lambda rule: rule.name)
         self.registry_version_str, self.base_name, self.prebuilt_rule_base = self.parse_registry(registry_version)
         self.directory = directory
-        self.package_directory = directory / "docs" / "detections" / "prebuilt-rules" / "downloadable-packages" / self.base_name  # noqa: E501
-        self.rule_details = directory / "docs" / "detections" / "prebuilt-rules" / "rule-details"
+        self.package_directory = directory / DOCS_DIR / "detections" / "prebuilt-rules" / "downloadable-packages" / self.base_name  # noqa: E501
+        self.rule_details = directory / DOCS_DIR / "detections" / "prebuilt-rules" / "rule-details"
         self.update_message = update_message
 
         if overwrite:
@@ -347,8 +349,8 @@ def generate_summary(self):
 
     def generate_rule_reference(self):
         """Generate rule reference page for prebuilt rules."""
-        summary = self.directory / "docs" / "detections" / "prebuilt-rules" / 'prebuilt-rules-reference.asciidoc'
-        rule_list = self.directory / "docs" / "detections" / "prebuilt-rules" / 'rule-desc-index.asciidoc'
+        summary = self.directory / DOCS_DIR / "detections" / "prebuilt-rules" / 'prebuilt-rules-reference.asciidoc'
+        rule_list = self.directory / DOCS_DIR / "detections" / "prebuilt-rules" / 'rule-desc-index.asciidoc'
 
         summary_header = textwrap.dedent("""
         [[prebuilt-rules]]