Skip to content

Install consolidated Cloud Docs, and edit primary navigation section in left sidebar #391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amotl merged 11 commits into from
Aug 3, 2023
Merged

Install consolidated Cloud Docs, and edit primary navigation section in left sidebar #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1768271
Sidebar navigation: CrateDB Cloud moved into consolidated repository
amotl Jul 26, 2023
d69c64c
Sidebar navigation: Add two more links to bottom section
amotl Jul 26, 2023
d915add
Sidebar navigation: Edit a few more link labels
amotl Jul 26, 2023
710bfef
Sidebar navigation: Improve appearance of bottom section
amotl Jul 27, 2023
2102408
Sidebar navigation: Improve appearance of topmost section
amotl Jul 31, 2023
ee13f76
Sidebar navigation: Move and adjust "CrateDB: Clients and Tools" project
amotl Aug 2, 2023
f2de1d3
Sidebar navigation: Dissolve section C, listing individual drivers
amotl Aug 2, 2023
e922902
Sidebar navigation: Fix typos
amotl Aug 2, 2023
4dba787
Sidebar navigation: Rename link label to "Drivers and Integrations"
amotl Aug 3, 2023
663676c
Sidebar navigation: Fix CHANGES
amotl Aug 3, 2023
21a2dd9
Consolidated Cloud Docs: Adjust intersphinx root references
amotl Aug 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------
Expand Down
6 changes: 3 additions & 3 deletions docs/links.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`


Expand Down
4 changes: 1 addition & 3 deletions src/crate/theme/rtd/conf/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
123 changes: 32 additions & 91 deletions src/crate/theme/rtd/crate/sidebartoc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,47 +9,54 @@

{% else %}

{% if project == 'CrateDB: Tutorials' %}
<!-- Section A. -->
{% if project == 'CrateDB Cloud' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Install CrateDB</a>
<a class="current-active" href="{{ pathto(master_doc) }}">CrateDB Cloud</a>
{{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/crate/tutorials/">Install CrateDB</a></li>
<li class="navleft-item"><a href="/docs/cloud/">CrateDB Cloud</a></li>
{% endif %}
{% if project == 'CrateDB: How-Tos' %}

{% if project == 'CrateDB: Tutorials' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">CrateDB</a>
<a class="current-active" href="{{ pathto(master_doc) }}">Self-Managed</a>
{{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/crate/howtos/">CrateDB</a></li>
<li class="navleft-item"><a href="/docs/crate/tutorials/">Self-Managed</a></li>
{% endif %}
{% if project == 'CrateDB: Reference' %}

{% if project == 'CrateDB: How-Tos' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Reference</a>
<a class="current-active" href="{{ pathto(master_doc) }}">Getting Started</a>
{{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/crate/reference/">Reference</a></li>
<li class="navleft-item"><a href="/docs/crate/howtos/">Getting Started</a></li>
{% endif %}
{% if project == 'CrateDB: Clients and Tools' %}

{% if project == 'CrateDB: Reference' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Clients and Tools</a>
<a class="current-active" href="{{ pathto(master_doc) }}">Reference Manual</a>
{{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/crate/clients-tools/">Clients and Tools</a></li>
<li class="navleft-item"><a href="/docs/crate/reference/">Reference Manual</a></li>
{% endif %}


<!-- Section B. -->
{% if project == 'CrateDB: Admin UI' %}
<li class="current">
<li class="current border-top">
<a class="current-active" href="{{ pathto(master_doc) }}">Admin UI</a>
{{ toctree(maxdepth=1|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/crate/admin-ui/">Admin UI</a></li>
<li class="navleft-item border-top"><a href="/docs/crate/admin-ui/">Admin UI</a></li>
{% endif %}

{% if project == 'CrateDB: Crash CLI' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Crash CLI</a>
Expand All @@ -59,84 +66,20 @@
<li class="navleft-item"><a href="/docs/crate/crash/">Crash CLI</a></li>
{% endif %}

<li class="navleft-item">CrateDB Cloud</li>
<ul>
{% if project == 'CrateDB Cloud: Tutorials' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Tutorials</a>
{{ toctree(maxdepth=2|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/cloud/tutorials/">Tutorials</a></li>
{% endif %}
{% if project == 'CrateDB Cloud: How-Tos' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">How-To Guides</a>
{{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/cloud/howtos/">How-To Guides</a></li>
{% endif %}
{% if project == 'CrateDB Cloud: Reference' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Reference</a>
{{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/cloud/reference/">Reference</a></li>
{% endif %}
{% if project == 'CrateDB Cloud: Croud CLI' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Croud CLI</a>
{{ toctree(maxdepth=2|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/cloud/cli/">Croud CLI</a></li>
{% endif %}
</ul>

{% if project == 'CrateDB JDBC' %}
<li class="current border-top">
<a class="current-active" href="{{ pathto(master_doc) }}">JDBC</a>
{{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item border-top"><a href="/docs/jdbc/">JDBC</a></li>
{% endif %}
{% if project == 'CrateDB DBAL' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">PHP DBAL</a>
{{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/dbal/">PHP DBAL</a></li>
{% endif %}
{% if project == 'CrateDB PDO' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">PHP PDO</a>
{{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/pdo/">PHP PDO</a></li>
{% endif %}
{% if project == 'CrateDB Python' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Python</a>
{{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/python/">Python</a></li>
{% endif %}
{% if project == 'CrateDB Npgsql' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">.NET Npgsql</a>
{{ toctree(maxdepth=1|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% if project == 'CrateDB: Clients and Tools' %}
<li class="current">
<a class="current-active" href="{{ pathto(master_doc) }}">Drivers and Integrations</a>
{{ toctree(maxdepth=3|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
</li>
{% else %}
<li class="navleft-item"><a href="/docs/npgsql/">.NET Npgsql</a></li>
<li class="navleft-item"><a href="/docs/crate/clients-tools/">Drivers and Integrations</a></li>
{% endif %}

<li class="navleft-item border-top"><a href="https://github.com/crate/crate-sample-apps">Sample Applications</a></li>
<!-- Section D. -->
<li class="navleft-item border-top"><a href="/support/">Support</a></li>
<li class="navleft-item"><a href="https://community.crate.io/">Community</a></li>
<li class="navleft-item"><a href="https://community.crate.io/t/overview-of-cratedb-integration-tutorials/1015">Integration Tutorials</a></li>
<li class="navleft-item"><a href="https://github.com/crate/crate-sample-apps">Sample Applications</a></li>

{% if project == 'Doing Docs' %}
<li class="current">
Expand All @@ -145,8 +88,6 @@
</li>
{% endif %}

<li class="navleft-item"><a href="/support/">Support</a></li>

{% endif %}

</ul>