Skip to content

Add initial Settings Overview page #566

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add initial Settings Overview page #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba3b6b8
Add initial Settings Overview page
ericholscher Feb 25, 2025
2a84b70
Address feedback round 1
ericholscher Feb 25, 2025
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
6 changes: 6 additions & 0 deletions readthedocsext/theme/templates/projects/edit_base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@
<div class="five wide computer five wide tablet sixteen wide mobile column">

<div class="ui vertical pointing fluid menu">
{# Overview link standalone before sections #}
<a class="item {% block project_overview_active %}{% endblock project_overview_active %}"
href="{% url "projects_overview" project.slug %}">
<i class="dashboard icon"></i>
{% trans "Project Overview" %}
</a>

<div class="item">
<div class="header">{% trans "Setup" %}</div>
Expand Down
236 changes: 236 additions & 0 deletions readthedocsext/theme/templates/projects/project_overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
{% 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 %}
{# Project Information #}
<div class="ui form">
<div class="ui segment">
<div class="field">
<label>{% trans "Project URL" %}</label>
<div class="ui fluid action input">
<input id="project-url"
type="text"
value="{{ project.get_docs_url }}"
readonly>
<button class="ui icon button" data-clipboard-target="#project-url">
<i class="fa-regular fa-copy"></i>
</button>
</div>
{% if not project.domains.exists %}
<div class="ui tiny message">
<i class="fa-solid fa-circle-info"></i>
{% url "projects_domains" project.slug as domains_url %}
{% blocktrans trimmed %}
Want to serve docs from your own domain? <a href="{{ domains_url }}">Configure a custom domain</a>.
{% endblocktrans %}
</div>
{% endif %}
</div>

<div class="three fields">
<div class="field">
<label>{% trans "Project Slug" %}</label>
<div class="ui fluid action input">
<input id="project-slug" type="text" value="{{ project.slug }}" readonly>
<button class="ui icon button" data-clipboard-target="#project-slug">
<i class="fa-regular fa-copy"></i>
</button>
</div>
</div>
<div class="field">
<label>{% trans "Repository" %}</label>
<div class="ui fluid action input">
<input id="project-repo" type="text" value="{{ project.repo }}" readonly>
<button class="ui icon button" data-clipboard-target="#project-repo">
<i class="fa-regular fa-copy"></i>
</button>
</div>
</div>
<div class="field">
<label>{% trans "Default Branch" %}</label>
<div class="ui fluid action input">
<input id="project-branch"
type="text"
value="{{ project.get_default_branch }}"
readonly>
<button class="ui icon button" data-clipboard-target="#project-branch">
<i class="fa-regular fa-copy"></i>
</button>
</div>
</div>
</div>
</div>

{# Build Activity #}
<div class="ui segment">
<h3 class="ui dividing header">{% trans "Build Activity" %}</h3>
<div class="four fields">
<div class="field">
<label>{% trans "Builds Last Month" %}</label>
<div class="ui fluid input">
<input type="text" value="{{ successful_builds }}" readonly>
</div>
</div>
<div class="field">
<label>{% trans "Build Minutes" %}</label>
<div class="ui fluid input">
<input type="text" value="{{ monthly_build_time|default:'0' }}" readonly>
</div>
</div>
<div class="field">
<label>{% trans "Concurrent Builds" %}</label>
<div class="ui fluid {% if concurrent_builds.limit_reached %}negative{% endif %} input">
<input type="text"
value="{{ concurrent_builds.current }}/{{ concurrent_builds.max }}"
readonly>
</div>
</div>
<div class="field">
<label>{% trans "Last Activity" %}</label>
<div class="ui fluid input">
<input type="text"
value="{% if project.has_valid_webhook %}{% trans "Webhook active" %}{% else %}{% trans "No recent activity" %}{% endif %}"
readonly>
</div>
</div>
</div>
<div class="ui small message">
<i class="fa-solid fa-circle-info"></i>
<a href="{% url 'builds_project_list' project.slug %}">
{% trans "View all builds" %}
</a>
</div>
</div>

{# Version Overview #}
<div class="ui segment">
<h3 class="ui dividing header">{% trans "Version Overview" %}</h3>
<div class="three fields">
<div class="field">
<label>{% trans "Active Versions" %}</label>
<div class="ui fluid input">
<input type="text" value="{{ active_versions_count }}" readonly>
</div>
</div>
<div class="field">
<label>{% trans "Default Version" %}</label>
<div class="ui fluid input">
<input type="text" value="{{ project.get_default_version }}" readonly>
</div>
</div>
<div class="field">
<label>{% trans "Privacy Level" %}</label>
<div class="ui fluid input">
<input type="text" value="{{ project.privacy_level }}" readonly>
</div>
</div>
</div>

{% if project.versions.exists %}
<div class="ui small message">
<i class="fa-solid fa-circle-info"></i>
<a href="{% url 'project_version_list' project.slug %}">
{% trans "Manage versions" %}
</a>
</div>
{% endif %}
</div>
</div>

{# Pull Request Builds #}
{% if not project.external_builds_enabled %}
<div class="ui info message">
<div class="header">{% trans "Enable Pull Request Previews" %}</div>
<p>
{% blocktrans trimmed %}
Pull request builds let you preview documentation changes before merging.
Get feedback on documentation changes alongside code review.
{% endblocktrans %}
</p>
<a href="{% url 'projects_pull_requests' project.slug %}"
class="ui basic button">
<i class="fa-solid fa-code-branch"></i>
{% trans "Enable Pull Request Builds" %}
</a>
</div>
{% endif %}

{# Private Versions #}
{% if project.has_private_versions %}
<div class="ui info message">
<div class="header">{% trans "Private Documentation" %}</div>
<p>
{% 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 %}
</p>
<a href="{% url 'projects_sharing' project.slug %}"
class="ui basic button">
<i class="fa-solid fa-shield-halved"></i>
{% trans "Manage Documentation Access" %}
</a>
</div>
{% endif %}

{# Addons section #}
{% if project.addons.enabled %}
<div class="ui positive message">
<div class="header">{% trans "Documentation Addons Enabled" %}</div>
<p>
{% blocktrans trimmed %}
Your project has addons enabled. You can configure them to enhance your documentation experience.
{% endblocktrans %}
</p>
<a href="{% url 'projects_addons' project.slug %}"
class="ui basic button">
<i class="fa-solid fa-puzzle-piece"></i>
{% trans "Configure Addons" %}
</a>
</div>
{% else %}
<div class="ui info message">
<div class="header">{% trans "Documentation Addons" %}</div>
<p>
{% blocktrans trimmed %}
Configure addons like search, version navigation menu, analytics and more.
<a href="https://docs.readthedocs.io/page/addons.html">Learn more about addons</a>.
{% endblocktrans %}
</p>
<a href="{% url 'projects_addons' project.slug %}"
class="ui basic button">
<i class="fa-solid fa-puzzle-piece"></i>
{% trans "Configure Addons" %}
</a>
</div>
{% endif %}

{# Danger Zone #}
<h3 class="ui dividing red header">{% trans "Danger Zone" %}</h3>
<div class="ui segment">
<form method="post" action="{% url 'projects_delete' project.slug %}">
{% csrf_token %}
<p>
{% trans "Permanently delete this project and all its associated data." %}
</p>
<button type="submit" class="ui red button">
<i class="trash icon"></i>
{% trans "Delete Project" %}
</button>
</form>
</div>
{% endblock project_edit_content %}

{% block body_scripts %}
{{ block.super }}
<script>// Remove custom clipboard logic</script>
{% endblock body_scripts %}