Skip to content

Directories with a single index.md file require special docset.yml pattern #764

Open
@bmorelli25

Description

@bmorelli25

Describe the bug

With the following directory structure:

Image

I'd expect to use this pattern to include files in docset.yml:

    - file: reference/1password/index.md
    - file: reference/abnormal_security/index.md
    - file: reference/activemq/index.md
    - file: reference/entityanalytics_ad/index.md
    - file: reference/admin_by_request_epm/index.md
    - file: reference/airflow/index.md
    - file: reference/akamai/index.md

However, following this pattern results in all of the above pages being silently excluded from the table of contents:

Image

Instead, the following pattern had be used to get the files to build to the table of contents:

  - file: reference/1password.md
  - file: reference/abnormal_security.md
  - file: reference/activemq.md
  - file: reference/entityanalytics_ad.md
  - file: reference/admin_by_request_epm.md
  - file: reference/airflow.md
  - file: reference/akamai.md

Here's the PR where @colleenmcginnis is working on this content: https://github.com/elastic/integration-docs/pull/688.

This is potentially related to #443?

Expected behavior

I should be able to use the full path to include these files.

Steps to reproduce

see above

Tooling

  • docs-builder
  • migration tooling
  • I'm not sure

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions