backstage / mkdocs-monorepo-plugin

✚ Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
https://backstage.github.io/mkdocs-monorepo-plugin/
Apache License 2.0
316 stars 74 forks source link

Running a build with this plugin includes a pile of files from /System/Volumes/Data/private #29

Closed swist closed 3 years ago

swist commented 3 years ago

I'm running macOS Big Sur.

my mkdocs.yml looks like this:

site_name: Garden Docs

nav:
  - Garden: garden/README.md
  - Garden Guide:
      - Setup: garden/00-setup.md
      - Remote Deployment: garden/01-remote-deployment.md
      - Remote Debugging: garden/02-remote-debugging.md
      - Adding A Module: garden/03-adding-a-module.md
      - Working With Garden: garden/04-working-with-garden.md
      - Known Issues: garden/05-known-issues.md
      - Cheatsheet: garden/06-cheatsheet.md
      - Compose To Garden Translation: garden/07-compose-to-garden-translation.md
      - Configuring Cluster: garden/08-configuring-cluster.md
      - Garden Ms Scaffold Explained: garden/09-garden-ms-scaffold-explained.md
      - Hot Reload: garden/10-hot-reload.md
  - Config: config.md
  - Docker Compose: docker-compose.md
  - Local Dev: local-dev.md
  - Packages: packages.md
  - Service Checklist: service-checklist.md

plugins:
  - techdocs-core

my filesystem tree looks like this:

.
├── docs
│   ├── config.md
│   ├── docker-compose.md
│   ├── garden
│   │   ├── 00-setup.md
│   │   ├── 01-remote-deployment.md
│   │   ├── 02-remote-debugging.md
│   │   ├── 03-adding-a-module.md
│   │   ├── 04-working-with-garden.md
│   │   ├── 05-known-issues.md
│   │   ├── 06-cheatsheet.md
│   │   ├── 07-compose-to-garden-translation.md
│   │   ├── 08-configuring-cluster.md
│   │   ├── 09-garden-ms-scaffold-explained.md
│   │   ├── 10-hot-reload.md
│   │   └── README.md
│   ├── local-dev.md
│   ├── packages.md
│   └── service-checklist.md
└── mkdocs.yml

upon building the docs with mkdocs build I get a lot of extraneous files

ls site
1E14906B-48F0-438B-B9F7-08FACA104585-lockscreen.png UpdateRingSettings.json                             local-dev
3CC215AE-598C-438D-B546-9BC231A6E374                assets                                              mat-debug-6273.log
3EA6F623-B3B8-4102-9EE3-CAB246C6AA2C                com.apple.Music                                     mat-debug-7205.log
404.html                                            com.apple.Safari                                    model.lock
5e84410f27304d289f168a76d51b240a.db                 com.apple.stocks.widget                             packages
5e84410f27304d289f168a76d51b240a.db-shm             com.microsoft.Outlook                               search
5e84410f27304d289f168a76d51b240a.db-wal             com.microsoft.teams Crashes                         service-checklist
5e84410f27304d289f168a76d51b240a.db.ses             config                                              sitemap.xml
ElixirSublime.log                                   docker-compose                                      sitemap.xml.gz
GitGutter.501                                       garden                                              techdocs_metadata.json
OneDriveVersion.xml                                 lghub Crashes                                       v8-compile-cache-501
TelemetryUploadFilecom.microsoft.autoupdate.fba.txt lghub_agent_instance_lock                           xcrun_db

I have somewhat isolated it to something between the tech docs plugin and this one

swist commented 3 years ago

D'oh, opened it against the wrong repo :(