Add a setting to control the paths for versioned docs

[PhilStollery]

I have a docs repo that has multiple products as their own sites. Some products need to support versioning of there docs. I'd like to be able to tell Docusaurus where to store the versioned folders - as having them all in the root directory is confusing.

I suggest that in the docusaurus.config.js file we added some new settings:

    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'kubernetes',
        path: 'products/esl/kubernetes',
        routeBasePath: 'kubernetes',
        sidebarPath: 'products/esl/kubernetes/sidebars.js',
        versionsFilePath: 'products/esl/kubernetes/versions.json',
        versionsArchivePath: 'products/esl/kubernetes/versioned_docs',
        versionedSidebarPath: 'products/esl/kubernetes/versioned_sidebars',
      },
    ],

Each of my products are in a products/function/product folder so I'd like to store their versions there as well.

[slorber]

Can you comment on the dedicated issue after reading it?

This would help to design the feature if we could better understand your motivations

#11288

[PhilStollery]

We have to take into consideration future goals, I'd like to explore:

- removing versions.json
- moving versioned_sidebars within the docs folder so that it gets versioned automatically

This idea would work for me, just that version_docs and version_sidebars needs to reside in the multi-site docs folder. I think? Happy to loose the versions.json if these settings are controlled somewhere else.

[PhilStollery]

The issue seems related but my use case is different. Our repo releases our docs from the main branch using CI CD. The issue I have is that we are using both Docs Mulit-instance and Versioning.

Our documentation will have over 35 products(multi-site) - and for a number of these producsts (mulit-site) we need to have between 2 or three versions of them.

I've structured the multi-sites to be in their own products/categegory/product - so all docs and settings for the product(mulit-site) are in there.

Enableing versioning on the product(mulit-site) then creates the version_docs, versioned_sidebars, versions.json at the root. So it's confusing to look for a products(multi-sites) content at the root and in the subfolders.

The feature request is to be able to set the paths for all the versioned content, so we can locate it nearer to where the current/dev/next version of the content is.

Current folder structure

platform/                           # Platform-facing documentation
├── products/
│   ├── data/                       # Data products category
│   │   ├── prod-1/
│   │   ├── prod-2/
│   │   ├── prod-3/
│   │   ├── prod-4/
│   │   └── prod-5/
│   ├── doe/                        # DevOps Engineering category
│   │   ├── prod-6/
│   │   ├── prod-7/
│   │   ├── prod-8/
│   │   └── prod-9/
│   ├── esl/                        # Enterprise Services Layer category
│   │   ├── prod-10/
│   │   ├── prod-11/
│   │   └── prod-12/
│   ├── iam/                        # Identity & Access Management category
│   │   ├── prod-13/
│   │   └── prod-14/
│   └── infra/                      # Infrastructure category
│       └── prod-15/
├── docs/
│   ├── documentation/
│   ├── support/
│   └── index.mdx
├── prod-1_versioned_docs/
├── prod-1_sidebars/
├── prod-8_versioned_docs/
├── prod-8_sidebars/
├── prod-13_versioned_docs/
├── prod-13_sidebars/
├── docusaurus.config.js
├── sidebars.js
├── package.json
├── prod-1_versions.json
├── prod-8_versions.json
└── prod-13_versions.json

The structure we'd like supported

platform/                           # Platform-facing documentation
├── products/
│   ├── data/                       # Data products category
│   │   ├── prod-1/
│   │   ├── prod-1_versioned_docs/
│   │   ├── prod-1_sidebars/
│   │   ├── prod-1_versions.json
│   │   ├── prod-2/
│   │   ├── prod-3/
│   │   ├── prod-4/
│   │   └── prod-5/
│   ├── doe/                        # DevOps Engineering category
│   │   ├── prod-6/
│   │   ├── prod-7/
│   │   ├── prod-8/
│   │   ├── prod-8_versioned_docs/
│   │   ├── prod-8_sidebars/
│   │   ├── prod-8_versions.json
│   │   └── prod-9/
│   ├── esl/                        # Enterprise Services Layer category
│   │   ├── prod-10/
│   │   ├── prod-11/
│   │   └── prod-12/
│   ├── iam/                        # Identity & Access Management category
│   │   ├── prod-13/
│   │   ├── prod-13_versioned_docs/
│   │   ├── prod-13_sidebars/
│   │   ├── prod-13_versions.json
│   │   └── prod-14/
│   └── infra/                      # Infrastructure category
│       └── prod-15/
├── docs/
│   ├── documentation/
│   ├── support/
│   └── index.mdx
├── docusaurus.config.js
├── sidebars.js
└── package.json

Can I add anymore information to make it clearer?

[slorber]

Understood thanks

The goal of commenting on the other issue is also to contribute to the existing discussion, and help design a public API that solves both use-cases. Even if the uise cases are different, the API to achieve both can be shared.

Also keeping in mind, as mentioned in the other issue, that I'd like to get rid of versions.json and versioned_sidebars dir