From ba3b6b8adf1c8cb7592dafbd07256e9db0f35fc4 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Mon, 24 Feb 2025 16:09:47 -0800 Subject: [PATCH 1/2] Add initial Settings Overview page This gives users a bit more context about their project, and is a starting point to introduce more information. This is a first draft, but curious to get some feedback on what should be included. I'm a little worried about the performance in production, so will put this behind a staff flag for now. --- .../templates/projects/project_overview.html | 179 ++++++++++++++++++ 1 file changed, 179 insertions(+) create mode 100644 readthedocsext/theme/templates/projects/project_overview.html diff --git a/readthedocsext/theme/templates/projects/project_overview.html b/readthedocsext/theme/templates/projects/project_overview.html new file mode 100644 index 00000000..d6d638b7 --- /dev/null +++ b/readthedocsext/theme/templates/projects/project_overview.html @@ -0,0 +1,179 @@ +{% extends "projects/project_edit_base.html" %} + +{% load trans blocktrans from i18n %} + +{% block title %} + {% trans "Project Overview" %} +{% endblock title %} + +{% block project_edit_content_header %} + {% trans "Project Overview" %} +{% endblock project_edit_content_header %} + +{% block project_edit_content %} +
+ {# Key Metrics #} +
+
+
+
+
+
+
{{ total_pageviews|default:"0" }}
+
{% trans "Page Views" %}
+
+
+
{% trans "Last 30 Days" %}
+
+
+
+
+
+
+
+
+
{{ total_searches|default:"0" }}
+
{% trans "Searches" %}
+
+
+
{% trans "Last 30 Days" %}
+
+
+
+
+
+
+
+
+
{{ successful_builds }}
+
{% trans "Builds" %}
+
+
+
{% trans "Last 30 Days" %}
+
+
+
+
+
+
+
+
+
{{ monthly_build_time|default:"0" }}
+
{% trans "Build Minutes" %}
+
+
+
{% trans "Last 30 Days" %}
+
+
+
+
+
+
+ + {# Documentation Setup #} +
+
+
+

+ +
{% trans "Documentation Setup" %}
+

+
+
+
+
{{ active_versions_count }}
+
{% trans "Active Versions" %}
+
+ + {% trans "Manage Versions" %} +
+
+
+
{{ domains_count }}
+
{% trans "Custom Domains" %}
+
+ + {% trans "Configure Domains" %} +
+
+
+
{{ integrations_count }}
+
{% trans "Git Integrations" %}
+
+ + {% trans "Setup Integrations" %} +
+
+
+
+
+ + {# Project Maintenance #} +
+
+
+

+ +
{% trans "Project Maintenance" %}
+

+
+
+
+
{{ redirect_count }}
+
{% trans "Redirects" %}
+
+ + {% trans "Manage Redirects" %} +
+
+
+
{{ webhook_count }}
+
{% trans "Webhooks" %}
+
+ + {% trans "Configure Webhooks" %} +
+
+
+
{{ maintainers_count }}
+
{% trans "Maintainers" %}
+
+ + {% trans "Manage Access" %} +
+
+
+
+
+ + {# Analytics Links #} +
+
+
+
+
+ + + {% trans "View Traffic Analytics" %} + +
+
+ + + {% trans "View Search Analytics" %} + +
+
+
+
+
+
+{% endblock body %} From 2a84b706931a71da0868137296cd2b8f72e3d171 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 25 Feb 2025 15:57:51 -0800 Subject: [PATCH 2/2] Address feedback round 1 --- .../theme/templates/projects/edit_base.html | 6 + .../templates/projects/project_overview.html | 345 ++++++++++-------- 2 files changed, 207 insertions(+), 144 deletions(-) diff --git a/readthedocsext/theme/templates/projects/edit_base.html b/readthedocsext/theme/templates/projects/edit_base.html index dd0d362a..6403a563 100644 --- a/readthedocsext/theme/templates/projects/edit_base.html +++ b/readthedocsext/theme/templates/projects/edit_base.html @@ -11,6 +11,12 @@
+ {# Overview link standalone before sections #} + + + {% trans "Project Overview" %} +
{% trans "Setup" %}
diff --git a/readthedocsext/theme/templates/projects/project_overview.html b/readthedocsext/theme/templates/projects/project_overview.html index d6d638b7..9dbeae86 100644 --- a/readthedocsext/theme/templates/projects/project_overview.html +++ b/readthedocsext/theme/templates/projects/project_overview.html @@ -11,169 +11,226 @@ {% endblock project_edit_content_header %} {% block project_edit_content %} -
- {# Key Metrics #} -
-
-
-
-
-
-
{{ total_pageviews|default:"0" }}
-
{% trans "Page Views" %}
-
-
-
{% trans "Last 30 Days" %}
-
-
-
+ {# Project Information #} +
+
+
+ +
+ +
-
-
-
-
-
{{ total_searches|default:"0" }}
-
{% trans "Searches" %}
-
-
-
{% trans "Last 30 Days" %}
-
-
+ {% if not project.domains.exists %} +
+ + {% url "projects_domains" project.slug as domains_url %} + {% blocktrans trimmed %} + Want to serve docs from your own domain? Configure a custom domain. + {% endblocktrans %} +
+ {% endif %} +
+ +
+
+ +
+ +
-
-
-
-
-
{{ successful_builds }}
-
{% trans "Builds" %}
-
-
-
{% trans "Last 30 Days" %}
-
-
+
+ +
+ +
-
-
-
-
-
{{ monthly_build_time|default:"0" }}
-
{% trans "Build Minutes" %}
-
-
-
{% trans "Last 30 Days" %}
-
-
+
+ +
+ +
- {# Documentation Setup #} -
-
-
-

- -
{% trans "Documentation Setup" %}
-

-
-
-
-
{{ active_versions_count }}
-
{% trans "Active Versions" %}
-
- - {% trans "Manage Versions" %} -
-
-
-
{{ domains_count }}
-
{% trans "Custom Domains" %}
-
- - {% trans "Configure Domains" %} -
-
-
-
{{ integrations_count }}
-
{% trans "Git Integrations" %}
-
- - {% trans "Setup Integrations" %} -
+ {# Build Activity #} +
+

{% trans "Build Activity" %}

+
+
+ +
+
-
-
- - {# Project Maintenance #} -
-
-
-

- -
{% trans "Project Maintenance" %}
-

-
-
-
-
{{ redirect_count }}
-
{% trans "Redirects" %}
-
- - {% trans "Manage Redirects" %} -
-
-
-
{{ webhook_count }}
-
{% trans "Webhooks" %}
-
- - {% trans "Configure Webhooks" %} -
-
-
-
{{ maintainers_count }}
-
{% trans "Maintainers" %}
-
- - {% trans "Manage Access" %} -
+
+ +
+ +
+
+
+ +
+ +
+
+
+ +
+
+
+ + + {% trans "View all builds" %} + +
- {# Analytics Links #} -
-
-
-
-
- - - {% trans "View Traffic Analytics" %} - -
-
- - - {% trans "View Search Analytics" %} - -
+ {# Version Overview #} +
+

{% trans "Version Overview" %}

+
+
+ +
+ +
+
+
+ +
+ +
+
+
+ +
+
+ + {% if project.versions.exists %} +
+ + + {% trans "Manage versions" %} + +
+ {% endif %} +
+
+ + {# Pull Request Builds #} + {% if not project.external_builds_enabled %} +
+
{% trans "Enable Pull Request Previews" %}
+

+ {% blocktrans trimmed %} + Pull request builds let you preview documentation changes before merging. + Get feedback on documentation changes alongside code review. + {% endblocktrans %} +

+ + + {% trans "Enable Pull Request Builds" %} +
+ {% endif %} + + {# Private Versions #} + {% if project.has_private_versions %} +
+
{% trans "Private Documentation" %}
+

+ {% blocktrans trimmed %} + Your project has private versions. You can share access using Single Sign-On (SSO), + or generate sharing tokens to give specific users access. + {% endblocktrans %} +

+ + + {% trans "Manage Documentation Access" %} + +
+ {% endif %} + + {# Addons section #} + {% if project.addons.enabled %} +
+
{% trans "Documentation Addons Enabled" %}
+

+ {% blocktrans trimmed %} + Your project has addons enabled. You can configure them to enhance your documentation experience. + {% endblocktrans %} +

+ + + {% trans "Configure Addons" %} + +
+ {% else %} +
+
{% trans "Documentation Addons" %}
+

+ {% blocktrans trimmed %} + Configure addons like search, version navigation menu, analytics and more. + Learn more about addons. + {% endblocktrans %} +

+ + + {% trans "Configure Addons" %} + +
+ {% endif %} + + {# Danger Zone #} +

{% trans "Danger Zone" %}

+
+
+ {% csrf_token %} +

+ {% trans "Permanently delete this project and all its associated data." %} +

+ +
-{% endblock body %} +{% endblock project_edit_content %} + +{% block body_scripts %} + {{ block.super }} + +{% endblock body_scripts %}