diff --git a/CHANGES.rst b/CHANGES.rst index f1749b81b..323e0c9c4 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -6,6 +6,20 @@ CHANGES Unreleased ---------- +- Edit primary navigation in left sidebar + + - "CrateDB Cloud" documentation has been bundled into a single repository, now + located at ``/docs/cloud`` + - Add link to "Community" and "Integration tutorials" + - Rename ``Install CrateDB`` to ``Install``, and ``Reference`` to ``CrateDB Reference`` + - Improve appearance of bottom section + +- Consolidated Cloud Docs: Adjust intersphinx root references + + - Those project references have been dissolved: + ``cloud-reference``, ``cloud-tutorials``, and ``cloud-howtos`` + - The new canonical intersphinx project reference is just ``cloud`` + 2023/08/01 0.28.2 ----------------- diff --git a/docs/links.rst b/docs/links.rst index 8c9eb869c..c4f5478ca 100644 --- a/docs/links.rst +++ b/docs/links.rst @@ -38,9 +38,9 @@ CrateDB clients CrateDB Cloud ------------- -- :ref:`cloud-reference:index` -- :ref:`cloud-tutorials:index` -- :ref:`cloud-howtos:index` +- :ref:`cloud:cloud-reference-index` +- :ref:`cloud:cloud-tutorials-index` +- :ref:`cloud:cloud-howtos-index` - :ref:`cloud-cli:index` diff --git a/src/crate/theme/rtd/conf/__init__.py b/src/crate/theme/rtd/conf/__init__.py index bc2b48770..38f2e8f64 100644 --- a/src/crate/theme/rtd/conf/__init__.py +++ b/src/crate/theme/rtd/conf/__init__.py @@ -116,9 +116,7 @@ 'crate-python': ('https://crate.io/docs/python/en/latest/', None), # CrateDB Cloud - 'cloud-reference': ('https://crate.io/docs/cloud/reference/en/latest/', None), - 'cloud-tutorials': ('https://crate.io/docs/cloud/tutorials/en/latest/', None), - 'cloud-howtos': ('https://crate.io/docs/cloud/howtos/en/latest/', None), + 'cloud': ('https://crate.io/docs/cloud/en/latest/', None), 'cloud-cli': ('https://crate.io/docs/cloud/cli/en/latest/', None), # Misc diff --git a/src/crate/theme/rtd/crate/sidebartoc.html b/src/crate/theme/rtd/crate/sidebartoc.html index 1fa7c1189..f19e577a8 100644 --- a/src/crate/theme/rtd/crate/sidebartoc.html +++ b/src/crate/theme/rtd/crate/sidebartoc.html @@ -9,47 +9,54 @@ {% else %} - {% if project == 'CrateDB: Tutorials' %} + + {% if project == 'CrateDB Cloud' %}
  • - Install CrateDB + CrateDB Cloud {{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
    • {% else %} -
  • Install CrateDB
    • +
  • CrateDB Cloud
    • {% endif %} - {% if project == 'CrateDB: How-Tos' %} + + {% if project == 'CrateDB: Tutorials' %}
  • - CrateDB + Self-Managed {{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
    • {% else %} -
  • CrateDB
    • +
  • Self-Managed
    • {% endif %} - {% if project == 'CrateDB: Reference' %} + + {% if project == 'CrateDB: How-Tos' %}
  • - Reference + Getting Started {{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
    • {% else %} -
  • Reference
    • +
  • Getting Started
    • {% endif %} - {% if project == 'CrateDB: Clients and Tools' %} + + {% if project == 'CrateDB: Reference' %}
  • - Clients and Tools + Reference Manual {{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
    • {% else %} -
  • Clients and Tools
    • +
  • Reference Manual
    • {% endif %} + + {% if project == 'CrateDB: Admin UI' %} -
  • +
  • Admin UI {{ toctree(maxdepth=1|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
    • {% else %} -
  • Admin UI
    • +
  • Admin UI
    • {% endif %} + {% if project == 'CrateDB: Crash CLI' %}
  • Crash CLI @@ -59,84 +66,20 @@
  • Crash CLI
    • {% endif %} -
  • CrateDB Cloud
    • - - - {% if project == 'CrateDB JDBC' %} -
  • - JDBC - {{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }} -
    • - {% else %} -
  • JDBC
    • - {% endif %} - {% if project == 'CrateDB DBAL' %} -
  • - PHP DBAL - {{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }} -
    • - {% else %} -
  • PHP DBAL
    • - {% endif %} - {% if project == 'CrateDB PDO' %} -
  • - PHP PDO - {{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }} -
    • - {% else %} -
  • PHP PDO
    • - {% endif %} - {% if project == 'CrateDB Python' %} -
  • - Python - {{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }} -
    • - {% else %} -
  • Python
    • - {% endif %} - {% if project == 'CrateDB Npgsql' %} -
  • - .NET Npgsql - {{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }} -
    • + {% if project == 'CrateDB: Clients and Tools' %} +
  • + Drivers and Integrations + {{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }} +
    • {% else %} -
  • .NET Npgsql
    • +
  • Drivers and Integrations
    • {% endif %} -
  • Sample Applications
    • + +
  • Support
    • +
  • Community
    • +
  • Integration Tutorials
    • +
  • Sample Applications
    • {% if project == 'Doing Docs' %}
  • @@ -145,8 +88,6 @@
    • {% endif %} -
  • Support
    • - {% endif %}