Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/preview-fork-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:
preview-branch: gh-pages
pages-base-url: libresign.github.io/site-preview
wait-for-pages-deployment: true
qr-code: false
qr-code: true
token: ${{ steps.preview-token.outputs.token }}

- name: Verify navigable public preview
Expand Down
14 changes: 11 additions & 3 deletions .github/workflows/preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
python -m versioning.verify --output _build
python -m versioning.publish --built _build --destination _publish
python -m versioning.verify --output _publish
rm _publish/CNAME
rm _publish/CNAME _publish/.nojekyll

- name: Render navigable HTML for unpublished release documentation
env:
Expand Down Expand Up @@ -79,6 +79,7 @@ jobs:
permission-contents: write

- name: Deploy preview to separate GitHub Pages origin
id: preview-deploy
if: github.event.pull_request.head.repo.full_name == github.repository
uses: LibreSign/pr-preview-action@2a6da1177b47dc23173ba9a75e01da0a0d800978
with:
Expand Down Expand Up @@ -131,7 +132,7 @@ jobs:
{
cat _publish/_review/routes.txt
find _publish -type f -name '*.html' -printf '/%P\n'
printf '%s\n' '/home.css' '/home-theme.js' '/versions.json'
printf '%s\n' '/home.css' '/ecosystem-nav.css' '/ecosystem-nav.js' '/scroll-navigation.js' '/home-theme.js' '/versions.json'
} | sort -u | while IFS= read -r route; do
[ -n "$route" ] || continue
local_page="_publish$route"
Expand Down Expand Up @@ -166,12 +167,19 @@ jobs:
env:
GH_TOKEN: ${{ github.token }}
PR_NUMBER: ${{ github.event.pull_request.number }}
PREVIEW_ROOT: https://libresign.github.io/site-preview/docs-preview/pr-${{ github.event.pull_request.number }}
ACTION_VERSION: ${{ steps.preview-deploy.outputs.action-version }}
ACTION_START_TIME: ${{ steps.preview-deploy.outputs.action-start-time }}
run: |
python -m versioning.pr_preview \
--site _publish --preview-root "$PREVIEW_ROOT" \
--action-version "$ACTION_VERSION" --built-at "$ACTION_START_TIME"
body=$(cat _publish/_review/preview-comment.md)
marker='<!-- libresign-documentation-preview-links -->'
legacy='<!-- libresign-documentation-review-screenshots -->'
native='<!-- Sticky Pull Request Commentpr-preview -->'
comment_id=$(gh api "repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER/comments?per_page=100" \
--paginate --jq ".[] | select(.body | contains(\"$marker\") or contains(\"$legacy\")) | .id" | head -n 1)
--paginate --jq ".[] | select(.body | contains(\"$marker\") or contains(\"$legacy\") or contains(\"$native\")) | .id" | head -n 1)
if [ -n "$comment_id" ]; then
gh api --method PATCH "repos/$GITHUB_REPOSITORY/issues/comments/$comment_id" \
-f body="$body" >/dev/null
Expand Down
58 changes: 58 additions & 0 deletions _templates/ecosystem-footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{# Shared resources for the landing page and every versioned Sphinx manual. #}
<footer class="libresign-site-footer" aria-label="LibreSign site footer">
<div class="libresign-footer-container">
<div class="libresign-footer-main">
<div class="libresign-footer-about">
<a class="libresign-footer-brand" href="https://libresign.coop/" aria-label="LibreSign official website">
<img src="{{ docs_home_href|e }}logo.png" width="136" height="55" alt="LibreSign">
</a>
<p>Open source electronic signatures for Nextcloud. Request, sign, and validate documents on infrastructure you control.</p>
<a class="libresign-footer-cta" href="https://libresign.coop/pricing/">Plans and professional support</a>
</div>
<nav class="libresign-footer-nav" aria-label="Footer resources">
<div class="libresign-footer-column">
<h2>Documentation</h2>
<ul>
<li><a href="{{ docs_home_href|e }}">All versions</a></li>
<li><a href="{{ docs_stable_href|e }}user_manual/">User manual</a></li>
<li><a href="{{ docs_stable_href|e }}admin_manual/">Administrator manual</a></li>
<li><a href="{{ docs_stable_href|e }}developer_manual/">Developer manual and API</a></li>
<li><a href="{{ docs_stable_href|e }}lifecycle.html">Release lifecycle</a></li>
</ul>
</div>
<div class="libresign-footer-column">
<h2>Product</h2>
<ul>
<li><a href="https://libresign.coop/features/">Features</a></li>
<li><a href="https://libresign.coop/pricing/">Plans and pricing</a></li>
<li><a href="https://apps.nextcloud.com/apps/libresign">Nextcloud App Store</a></li>
<li><a href="https://libresign.coop/about/">About LibreSign</a></li>
<li><a href="https://libresign.coop/posts/">Blog</a></li>
</ul>
</div>
<div class="libresign-footer-column">
<h2>Community</h2>
<ul>
<li><a href="https://github.com/LibreSign/libresign">Source code</a></li>
<li><a href="https://github.com/LibreSign/libresign/blob/main/CONTRIBUTING.md">How to contribute</a></li>
<li><a href="https://github.com/LibreSign/documentation">Improve the documentation</a></li>
<li><a href="https://t.me/libresign">Community chat</a></li>
</ul>
</div>
<div class="libresign-footer-column">
<h2>Support</h2>
<ul>
<li><a href="https://libresign.coop/faq/">Frequently asked questions</a></li>
<li><a href="https://libresign.coop/contact-us/">Contact our team</a></li>
<li><a href="https://github.com/LibreSign/libresign/issues">Report a problem</a></li>
<li><a href="https://libresign.coop/brand/">Brand and pronunciation</a></li>
</ul>
</div>
</nav>
</div>
<div class="libresign-footer-bottom">
<span>Developed by <a href="https://librecode.coop/">LibreCode cooperative</a>.</span>
<span>Documentation licensed under <a href="https://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</span>
</div>
</div>
</footer>
60 changes: 60 additions & 0 deletions _templates/ecosystem-nav.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
{# Shared links to LibreSign services; keep product content on the official site. #}
<div class="libresign-nav-shell">
<button class="libresign-nav-toggle" type="button" aria-controls="libresign-ecosystem-links"
aria-expanded="false" aria-label="Open LibreSign navigation">
<svg aria-hidden="true" viewBox="0 0 24 24" width="19" height="19" fill="none"
stroke="currentColor" stroke-width="1.9" stroke-linecap="round">
<path d="M4 6h16M4 12h16M4 18h16"/>
</svg>
<span>Menu</span>
</button>
<nav class="libresign-ecosystem-nav" id="libresign-ecosystem-links"
aria-label="LibreSign ecosystem">
<a class="libresign-nav-docs" href="{{ docs_home_href|default('/', true)|e }}">Documentation</a>
<details class="libresign-nav-group">
<summary>Product</summary>
<div class="libresign-nav-menu">
<a href="https://libresign.coop/">LibreSign overview</a>
<a href="https://libresign.coop/features/">Features</a>
<a href="https://libresign.coop/pricing/">Plans and pricing</a>
</div>
</details>
<details class="libresign-nav-group">
<summary>Support</summary>
<div class="libresign-nav-menu">
<a href="{{ docs_home_href|default('/', true)|e }}">Documentation</a>
<a href="https://libresign.coop/faq/">Frequently asked questions</a>
<a href="https://libresign.coop/contact-us/">Contact our team</a>
<a href="https://github.com/LibreSign/libresign/issues">Report a problem</a>
</div>
</details>
<details class="libresign-nav-group">
<summary>Community</summary>
<div class="libresign-nav-menu">
<a href="https://github.com/LibreSign/libresign">Source code</a>
<a href="https://github.com/LibreSign/libresign/blob/main/CONTRIBUTING.md">How to contribute</a>
<a href="https://t.me/libresign">Community chat</a>
<a href="https://apps.nextcloud.com/apps/libresign">Nextcloud App Store</a>
</div>
</details>
<details class="libresign-nav-group">
<summary>About</summary>
<div class="libresign-nav-menu">
<a href="https://libresign.coop/about/">About LibreSign</a>
<a href="https://libresign.coop/posts/">Blog</a>
<a href="https://librecode.coop/">LibreCode cooperative</a>
</div>
</details>
<a class="libresign-nav-quote" href="https://libresign.coop/pricing/">Request a quote</a>
<a class="libresign-nav-source" href="https://github.com/LibreSign/documentation"
aria-label="Documentation source on GitHub" title="Documentation source on GitHub">
<svg aria-hidden="true" viewBox="0 0 24 24" width="16" height="16"
fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round"
stroke-linejoin="round">
<path d="M8 3H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-3"/>
<path d="M12 12 21 3M15 3h6v6"/>
</svg>
<span>Source</span>
</a>
</nav>
</div>
110 changes: 72 additions & 38 deletions _templates/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="LibreSign documentation by stable release and Nextcloud compatibility.">
<meta name="description" content="LibreSign documentation for upcoming, stable, and historical releases, including Nextcloud compatibility.">
<title>LibreSign documentation · Versions and manuals</title>
<script src="home-theme.js"></script>
<link rel="stylesheet" href="home.css">
<link rel="stylesheet" href="ecosystem-nav.css">
<link rel="stylesheet" href="ecosystem-footer.css">
<script src="ecosystem-nav.js" defer></script>
<script src="scroll-navigation.js" defer></script>
</head>
<body>
<div class="page-shell">
Expand All @@ -16,77 +20,107 @@
· <a href="_review/">Review unpublished pages</a> · Not published
</div>
{% endif %}
<header class="page-header">
<header class="page-header libresign-scroll-header">
<a class="brand" href="./" aria-label="LibreSign documentation home">
<img src="logo.png" alt="LibreSign" width="110" height="49">
<span class="brand-subtitle">Documentation</span>
</a>
<a class="source-link" href="https://github.com/LibreSign/documentation">Documentation source</a>
{% include "ecosystem-nav.html" %}
</header>
<main id="main-content">
<div class="hero">
<p class="eyebrow">Documentation by release</p>
<h1>Find documentation for your version of LibreSign.</h1>
<p>Choose the version installed on your Nextcloud server. Each manual
includes the API contract from that release, not from the development branch.</p>
<h1>Find the LibreSign documentation for your version.</h1>
<p>LibreSign adds document signing, signature requests, and validation to Nextcloud.
Choose the LibreSign release installed on your server: each manual and API
contract belongs to that release, not to the development branch.</p>
<p class="latest-reference">Latest stable: <a href="{{ current_stable }}/">
LibreSign {{ current_stable }}</a>
{% for entry in versions if entry.slug == current_stable %}
· Nextcloud {{ entry.nextcloud_min }}{% if entry.nextcloud_min != entry.nextcloud_max %}–{{ entry.nextcloud_max }}{% endif %}
{% endfor %}
</p>
<p class="product-shortcuts">New to LibreSign?
<a href="https://libresign.coop/features/">Explore product features</a> ·
<a href="https://apps.nextcloud.com/apps/libresign">Get the Nextcloud app</a> ·
<a href="https://libresign.coop/contact-us/">Talk to our team</a>
</p>
</div>
<section class="quick-tasks" aria-labelledby="quick-tasks-title">
<h2 id="quick-tasks-title">Find a task</h2>
<p>Start with the latest stable LibreSign {{ current_stable }} manual, or choose your
installed version below.</p>
<ul>
<li><a href="{{ current_stable }}/user_manual/start.html">Get started with signing</a></li>
<li><a href="{{ current_stable }}/user_manual/functionality.html">Request and track signatures</a></li>
<li><a href="{{ current_stable }}/user_manual/functionality.html">Validate a signed PDF</a></li>
<li><a href="{{ current_stable }}/admin_manual/installation.html">Install and configure LibreSign</a></li>
<li><a href="{{ current_stable }}/developer_manual/integration/index.html">Integrate another application</a></li>
</ul>
</section>
<section class="versions-section" aria-labelledby="versions-title">
<div class="section-heading">
<h2 id="versions-title">Available versions</h2>
<p>Latest stable first. Development documentation is listed separately.</p>
<h2 id="versions-title">Upcoming and stable versions</h2>
<p>Development first, followed by stable releases. Check the installed version before following a guide.</p>
</div>
<div class="version-list">
{% for entry in versions %}
<article class="version-row {% if entry.status == 'current' %}version-current{% endif %}" data-version="{{ entry.slug }}">
{% for entry in versions if entry.status != 'eol' %}
<article class="version-row {% if entry.status == 'current' %}version-current{% elif entry.status == 'development' %}version-upcoming{% endif %}" data-version="{{ entry.slug }}">
<div class="version-identification">
<h3><a href="{{ entry.slug }}/">
{% if entry.slug == 'main' %}{% if entry.app_version is defined %}LibreSign {{ entry.app_version.split('.')[0] }}{% else %}Development{% endif %}{% else %}LibreSign {{ entry.slug }}{% endif %}
</a></h3>
<p class="release-status">
{% if entry.status == 'development' %}Development (not a stable release)
{% elif entry.status == 'eol' %}End of support
{% elif entry.status == 'current' %}Latest stable
{% else %}Earlier stable release{% endif %}
</p>
<h3><a href="{{ entry.slug }}/">{% if entry.slug == 'main' %}LibreSign · Upcoming{% else %}LibreSign {{ entry.slug }}{% endif %}</a></h3>
{% if entry.status == 'development' %}
<p class="release-status">Upcoming release · documentation in development (not released)</p>
{% elif entry.status == 'current' %}
<p class="release-status">Latest stable release</p>
{% elif entry.slug == oldest_stable %}
<p class="release-status">Oldest documented stable release</p>
{% endif %}
<p class="compatibility">Nextcloud {{ entry.nextcloud_min }}{% if entry.nextcloud_min != entry.nextcloud_max %}–{{ entry.nextcloud_max }}{% endif %}</p>
</div>
<nav class="manual-links" aria-label="{% if entry.slug == 'main' %}{% if entry.app_version is defined %}LibreSign {{ entry.app_version.split('.')[0] }}{% else %}Development{% endif %}{% else %}LibreSign {{ entry.slug }}{% endif %} manuals">
<nav class="manual-links" aria-label="{% if entry.slug == 'main' %}Upcoming LibreSign{% else %}LibreSign {{ entry.slug }}{% endif %} manuals">
<a href="{{ entry.slug }}/user_manual/">User manual</a>
<a href="{{ entry.slug }}/admin_manual/">Administrator manual</a>
<a href="{{ entry.slug }}/developer_manual/">Developer manual and API</a>
</nav>
</article>
{% endfor %}
</div>
<details class="archived-releases">
<summary>Older releases and end-of-life documentation</summary>
<div class="archived-content">
<p>Archived manuals are for historical reference only. Their availability does not
imply security updates or commercial support.</p>
{% for entry in versions if entry.status == 'eol' %}
<article class="archive-row" data-version="{{ entry.slug }}">
<strong>LibreSign {{ entry.slug }} · Nextcloud {{ entry.nextcloud_min }}{% if entry.nextcloud_min != entry.nextcloud_max %}–{{ entry.nextcloud_max }}{% endif %}</strong>
<span>End of support{% if entry.eol_date %} · {{ entry.eol_date }}{% endif %}</span>
<nav class="manual-links" aria-label="LibreSign {{ entry.slug }} archived manuals">
<a href="{{ entry.slug }}/user_manual/">User manual</a>
<a href="{{ entry.slug }}/admin_manual/">Administrator manual</a>
<a href="{{ entry.slug }}/developer_manual/">Developer manual and API</a>
</nav>
</article>
{% endfor %}
{% if not (versions | selectattr('status', 'equalto', 'eol') | list) %}
<p>No verified end-of-life manuals are published in this catalog yet.</p>
{% endif %}
{% if not (versions | selectattr('slug', 'equalto', '12') | list) %}
<p>LibreSign 12 was used with Nextcloud 32, but there is no verified
LibreSign 12 manual in this versioned site. A
<a href="https://github.com/LibreSign/documentation/tree/c63c3f3a51b41cfc533294df6ebe716ee4b07e07">historical documentation snapshot</a>
exists; it has not been audited for compatibility with that release.
Do not substitute a newer manual for it.</p>
{% endif %}
</div>
</details>
</section>
<section class="quick-tasks" aria-labelledby="quick-tasks-title">
<h2 id="quick-tasks-title">Find a task</h2>
<p>These shortcuts use the latest stable LibreSign {{ current_stable }} documentation.
Select your installed version above if you use an older release.</p>
<ul>
<li><a href="{{ current_stable }}/user_manual/start.html">Get started with signing</a></li>
<li><a href="{{ current_stable }}/user_manual/functionality.html">Request and track signatures</a></li>
<li><a href="{{ current_stable }}/user_manual/functionality.html">Validate a signed PDF</a></li>
<li><a href="{{ current_stable }}/admin_manual/installation.html">Install and configure LibreSign</a></li>
<li><a href="{{ current_stable }}/developer_manual/integration/index.html">Integrate another application</a></li>
</ul>
</section>
<p class="lifecycle-note">Release history is maintained in the
<a href="https://github.com/LibreSign/libresign/releases">application repository</a>.
Archived documentation does not imply continued security maintenance or commercial support.
The oldest documented stable release is not necessarily the last release receiving security updates:
consult the <a href="{{ current_stable }}/lifecycle.html">release lifecycle</a> for support information.
</p>
</main>
<footer class="page-footer">
<span>LibreSign · Free and open source digital signatures</span>
<a href="{{ current_stable }}/lifecycle.html">Release lifecycle</a>
</footer>
</div>
{% include "ecosystem-footer.html" %}
<button class="theme-switcher" id="themeSwitcher" type="button"
aria-label="Dark mode" aria-pressed="false" hidden>
<svg class="theme-icon-moon" aria-hidden="true" viewBox="0 0 24 24"
Expand Down
Loading
Loading