move non-Qiskit documentation out of qiskit.org/documentation

[1ucian0]

As we move towards a more strict qiskit == qiskit-terra, the non-qiskit projects that are deploying their documentation in qiskit.org/documentation/<something> need to slowly start moving somewhere else. In most cases, that will be qiskit.org/ecosystem/<something>. This affects the following projects:

1. https://qiskit.org/documentation/aer/
2. https://qiskit.org/documentation/rustworkx/
3. https://qiskit.org/documentation/retworkx/
4. https://qiskit.org/documentation/partners/ionq/
5. https://qiskit.org/documentation/partners/aqt/
6. https://qiskit.org/documentation/experiments/
7. https://qiskit.org/documentation/nature/
8. https://qiskit.org/documentation/optimization/
9. https://qiskit.org/documentation/partners/qiskit_ibm_runtime/
10. https://qiskit.org/documentation/machine-learning/
11. https://qiskit.org/documentation/finance/
12. https://qiskit.org/documentation/partners/mthree/
13. https://qiskit.org/documentation/partners/qiskit_ibm_provider/
14. https://qiskit.org/documentation/partners/qiskit_ibm_experiment/
15. https://qiskit.org/documentation/neko/
16. https://qiskit.org/documentation/metal/
17. https://qiskit.org/documentation/dynamics/

The tasks for each of these projects are the following:

• preserve /ecosystem exclude ecosystem/ subdirectories from rclone sync #3011
• copy current documentation to ecosystem
  • https://qiskit.org/ecosystem/aer/
  • https://qiskit.org/ecosystem/rustworkx/
  • https://qiskit.org/ecosystem/ionq/
  • https://qiskit.org/ecosystem/aqt/
  • https://qiskit.org/ecosystem/experiments/
  • https://qiskit.org/ecosystem/nature/
  • https://qiskit.org/ecosystem/optimization/
  • https://qiskit.org/ecosystem/ibm-runtime/
  • https://qiskit.org/ecosystem/machine-learning/
  • https://qiskit.org/ecosystem/finance/
  • https://qiskit.org/ecosystem/mthree/
  • https://qiskit.org/ecosystem/ibm-provider/
  • https://qiskit.org/ecosystem/ibm-experiment/
  • https://qiskit.org/ecosystem/neko/
  • https://qiskit.org/ecosystem/metal/
  • https://qiskit.org/ecosystem/dynamics/
• deploy in ecosystem next time deploy Qiskit Ecosystem Main tier documentation to qiskit.org/ecosystem #3038
• configure CDN to redirect (notice that the prefix qiskit- can be removed):
  • documentation/aer -> ecosystem/aer
  • documentation/rustworkx -> ecosystem/rustworkx
  • documentation/retworkx -> ecosystem/rustworkx
  • documentation/partners/ionq -> ecosystem/ionq
  • documentation/partners/aqt -> ecosystem/aqt
  • documentation/experiments -> ecosystem/experiments
  • documentation/nature -> ecosystem/nature
  • documentation/optimization -> ecosystem/optimization
  • documentation/partners/qiskit_ibm_runtime -> ecosystem/ibm-runtime
  • documentation/machine-learning -> ecosystem/machine-learning
  • documentation/finance -> ecosystem/finance
  • documentation/partners/mthree -> ecosystem/mthree
  • documentation/partners/qiskit_ibm_provider -> ecosystem/ibm-provider
  • documentation/partners/qiskit_ibm_experiment -> ecosystem/ibm-experiment
  • documentation/neko -> ecosystem/neko
  • documentation/metal -> ecosystem/metal
  • documentation/dynamics -> ecosystem/dynamics
• create new sphinx theme for ecosystem projects Epic: Add Ecosystem Theme Variant qiskit_sphinx_theme#311
• stop deploying on /documentation deploy Qiskit Ecosystem Main tier documentation to qiskit.org/ecosystem #3038 (comment)
• depend on new theme

[HuangJunye]

Moving qiskit-ibmq-provider documentation to its own standalone documentation site is not mentioned here. We can create a separate issue in an appropriate repo. But I just want to mention it here and @Guillermo-Mijares-Vilarino will work on that.

[1ucian0]

configure CDN to redirect

Submitted the following redirects:

const DOCS_ECOSYSTEM_REDIRECTIONS = [
    [/^qiskit\.org\/documentation\/partners\/ionq\/(.*)/, 'qiskit.org/ecosystem/ionq/$1'],
    [/^qiskit\.org\/documentation\/partners\/aqt\/(.*)/, 'qiskit.org/ecosystem/aqt/$1'],
    [/^qiskit\.org\/documentation\/partners\/ibm-runtime\/(.*)/, 'qiskit.org/ecosystem/ibm-runtime/$1'],
    [/^qiskit\.org\/documentation\/partners\/qiskit_ibm_provider\/(.*)/, 'qiskit.org/ecosystem/ibm-provider/$1'],
    [/^qiskit\.org\/documentation\/partners\/qiskit_ibm_experiment\/(.*)/, 'qiskit.org/ecosystem/ibm-experiment/$1'],
    [/^qiskit\.org\/documentation\/partners\/mthree\/(.*)/, 'qiskit.org/ecosystem/mthree/$1'],
    [/^qiskit\.org\/documentation\/aer\/(.*)/, 'qiskit.org/ecosystem/aer/$1'],
    [/^qiskit\.org\/documentation\/rustworkx\/(.*)/, 'qiskit.org/ecosystem/rustworkx/$1'],
    [/^qiskit\.org\/documentation\/experiments\/(.*)/, 'qiskit.org/ecosystem/experiments/$1'],
    [/^qiskit\.org\/documentation\/nature\/(.*)/, 'qiskit.org/ecosystem/nature/$1'],
    [/^qiskit\.org\/documentation\/optimization\/(.*)/, 'qiskit.org/ecosystem/optimization/$1'],
    [/^qiskit\.org\/documentation\/machine-learning\/(.*)/, 'qiskit.org/ecosystem/machine-learning/$1'],
    [/^qiskit\.org\/documentation\/finance\/(.*)/, 'qiskit.org/ecosystem/finance/$1']
];

redirect applied on April 14th, 2023 - 19:07 UTC

Some redirect that are not working or not implemented:

• https://qiskit.org/documentation/partners/qiskit_ibm_runtime/
• https://qiskit.org/documentation/partners/qiskit_ibm_experiment/

[1ucian0]

Moving qiskit-ibmq-provider documentation to its own standalone documentation site is not mentioned here. We can create a separate issue in an appropriate repo. But I just want to mention it here and @Guillermo-Mijares-Vilarino will work on that.

For reference Qiskit/qiskit-ibmq-provider#1166

It is not in the list because does not have to be moved, it can be created directly in q.o/ecosystem.

[y4izus]

These URLs already have the redirections, so I've checked them on the list:

• https://qiskit.org/documentation/partners/qiskit_ibm_experiment/ -> https://qiskit.org/ecosystem/ibm-experiment/
• https://qiskit.org/documentation/dynamics/ -> https://qiskit.org/ecosystem/dynamics/
• https://qiskit.org/documentation/partners/qiskit_ibm_runtime/ -> https://qiskit.org/ecosystem/ibm-runtime/

[y4izus]

These URLs already have the redirections, so I've checked them on the list:

• documentation/rustworkx -> ecosystem/rustworkx
• documentation/neko -> ecosystem/neko
• documentation/metal -> ecosystem/metal

[1ucian0]

the residual PRs are on non-blocking components.