From c08355b9f27862244d4e0804d2a12435bb420019 Mon Sep 17 00:00:00 2001 From: Jonah Aragon Date: Thu, 4 Apr 2024 01:47:06 -0500 Subject: [PATCH] footer improvements --- config/mkdocs-common.yml | 97 ++++++++++++++----- includes/strings.en.env | 16 ++- theme/home.html | 18 ++-- theme/partials/content.html | 9 +- .../partials/{footer.html => copyright.html} | 37 ++++--- 5 files changed, 117 insertions(+), 60 deletions(-) rename theme/partials/{footer.html => copyright.html} (61%) diff --git a/config/mkdocs-common.yml b/config/mkdocs-common.yml index 349e6dc2fd..dee6646795 100644 --- a/config/mkdocs-common.yml +++ b/config/mkdocs-common.yml @@ -28,8 +28,6 @@ site_description: SITE_DESCRIPTION, "Privacy Guides is your central privacy and security resource to protect yourself online.", ] -copyright: - !ENV [FOOTER_COPYRIGHT, "© 2019 Privacy Guides and contributors."] edit_uri_template: blob/main/docs/{path}?plain=1 extra: @@ -37,6 +35,26 @@ extra: context: !ENV [CONTEXT, "production"] deploy: !ENV DEPLOY_ID privacy_guides: + footer: + intro: + !ENV [ + FOOTER_INTRO, + "Privacy Guides is a non-profit, socially motivated website that provides information for protecting your data security and privacy.", + ] + note: + !ENV [ + FOOTER_NOTE, + "We do not make money from recommending certain products, and we do not use affiliate links.", + ] + copyright: + author: + !ENV [FOOTER_COPYRIGHT_AUTHOR, "Privacy Guides and contributors."] + date: !ENV [FOOTER_COPYRIGHT_DATE, "2019-2024"] + license: + - fontawesome/brands/creative-commons + - fontawesome/brands/creative-commons-by + - fontawesome/brands/creative-commons-nd + analytics: !ENV [FOOTER_ANALYTICS, "Anonymous statistics preferences."] homepage: description: !ENV [ @@ -72,6 +90,39 @@ extra: ] link: tools/ class: md-button + cta: + - title: + !ENV [ + HOMEPAGE_CTA_TITLE, + "We need you! Here's how to get involved:", + ] + links: + - icon: simple/discourse + name: !ENV [HOMEPAGE_CTA_FORUM_NAME, "Join the forum"] + link: https://discuss.privacyguides.net/ + - icon: simple/mastodon + name: !ENV [HOMEPAGE_CTA_MASTODON_NAME, "Follow us on Mastodon"] + link: https://mastodon.neat.computer/@privacyguides + - icon: simple/github + name: !ENV [HOMEPAGE_CTA_GITHUB_NAME, "Contribute on GitHub"] + link: https://github.com/privacyguides/privacyguides.org + - icon: material/translate + name: !ENV [HOMEPAGE_CTA_TRANSLATE_NAME, "Help translate"] + link: https://crowdin.com/project/privacyguides + - icon: simple/matrix + name: !ENV [HOMEPAGE_CTA_MATRIX_NAME, "Join the Matrix chat"] + link: https://matrix.to/#/#privacyguides:matrix.org + - icon: material/information-outline + name: !ENV [HOMEPAGE_CTA_ABOUT_NAME, "Learn more about us"] + link: about/ + - icon: material/hand-coin + name: !ENV [HOMEPAGE_CTA_DONATE_NAME, "Donate to Privacy Guides"] + link: about/donate/ + description: + !ENV [ + HOMEPAGE_CTA_DESCRIPTION, + "If you spot an error, think a provider should not be listed, notice a qualified provider is missing, believe a browser plugin is no longer the best choice, or uncover any other issue, please let us know.", + ] rss: - title: !ENV [ @@ -106,25 +157,26 @@ extra: HOMEPAGE_RSS_FORUM_LINK, "https://discuss.privacyguides.net/latest.rss", ] - translation_notice: !ENV DESCRIPTION_TRANSLATION - translation_notice_cta: !ENV [DESCRIPTION_TRANSLATION_CTA, "Visit Crowdin"] - translation_notice_language: !ENV LANG_ENGLISH - social: - - icon: simple/mastodon - link: https://mastodon.neat.computer/@privacyguides - name: !ENV [SOCIAL_MASTODON, "Mastodon"] - - icon: simple/matrix - link: https://matrix.to/#/#privacyguides:matrix.org - name: !ENV [SOCIAL_MATRIX, "Matrix"] - - icon: simple/discourse - link: https://discuss.privacyguides.net/ - name: !ENV [SOCIAL_FORUM, "Forum"] - - icon: simple/github - link: https://github.com/privacyguides - name: !ENV [SOCIAL_GITHUB, "GitHub"] - - icon: simple/torbrowser - link: http://www.xoe4vn5uwdztif6goazfbmogh6wh5jc4up35bqdflu6bkdc5cas5vjqd.onion/ - name: !ENV [SOCIAL_TOR_SITE, "Hidden service"] + translation_notice: + notice: !ENV TRANSLATION_NOTICE + cta: !ENV [TRANSLATION_NOTICE_CTA, "Visit Crowdin"] + language: !ENV LANG_ENGLISH + social: + - icon: simple/mastodon + link: https://mastodon.neat.computer/@privacyguides + name: !ENV [SOCIAL_MASTODON, "Mastodon"] + - icon: simple/matrix + link: https://matrix.to/#/#privacyguides:matrix.org + name: !ENV [SOCIAL_MATRIX, "Matrix"] + - icon: simple/discourse + link: https://discuss.privacyguides.net/ + name: !ENV [SOCIAL_FORUM, "Forum"] + - icon: simple/github + link: https://github.com/privacyguides + name: !ENV [SOCIAL_GITHUB, "GitHub"] + - icon: simple/torbrowser + link: http://www.xoe4vn5uwdztif6goazfbmogh6wh5jc4up35bqdflu6bkdc5cas5vjqd.onion/ + name: !ENV [SOCIAL_TOR_SITE, "Hidden service"] alternate: - name: English link: /en/ @@ -235,9 +287,6 @@ theme: - navigation.expand - navigation.path - navigation.indexes - - navigation.instant - - navigation.instant.prefetch - - navigation.instant.progress - navigation.instant.preview - content.action.edit - content.tabs.link diff --git a/includes/strings.en.env b/includes/strings.en.env index 74f627abed..182f4b926c 100644 --- a/includes/strings.en.env +++ b/includes/strings.en.env @@ -6,15 +6,11 @@ ANALYTICS_FEEDBACK_POSITIVE_NAME="This page was helpful" ANALYTICS_FEEDBACK_POSITIVE_NOTE="Thanks for your feedback!" ANALYTICS_FEEDBACK_TITLE="Was this page helpful?" DESCRIPTION_HOMEPAGE="A socially motivated website which provides information about protecting your online data privacy and security." -DESCRIPTION_TRANSLATION="You're viewing the $LANG copy of Privacy Guides, translated by our fantastic language team on Crowdin. If you notice an error, or see any untranslated sections on this page, please consider helping out!" -DESCRIPTION_TRANSLATION_CTA="Visit Crowdin" -FOOTER_COPYRIGHT_AFFILIATE="We do not make money from recommending certain products, and we do not use affiliate links." -FOOTER_COPYRIGHT_ANALYTICS="Anonymous statistics preferences." -FOOTER_COPYRIGHT_DATE="2019 - 2024 Privacy Guides and contributors." -FOOTER_COPYRIGHT_ICON='' -FOOTER_COPYRIGHT_INTRO="Privacy Guides is a non-profit, socially motivated website that provides information for protecting your data security and privacy." -FOOTER_COPYRIGHT_LICENSE="Content license:" -FOOTER_COPYRIGHT="$FOOTER_COPYRIGHT_INTRO
$FOOTER_COPYRIGHT_AFFILIATE
© $FOOTER_COPYRIGHT_DATE $FOOTER_COPYRIGHT_ICON $FOOTER_COPYRIGHT_LICENSE CC BY-ND 4.0. $FOOTER_COPYRIGHT_ANALYTICS" +FOOTER_ANALYTICS="Anonymous statistics preferences." +FOOTER_COPYRIGHT_AUTHOR="Privacy Guides and contributors." +FOOTER_INTRO="Privacy Guides is a non-profit, socially motivated website that provides information for protecting your data security and privacy." +FOOTER_NOTE="We do not make money from recommending certain products, and we do not use affiliate links." +HOMEPAGE_CTA_DESCRIPTION="It's important for a website like Privacy Guides to always stay up-to-date. We need our audience to keep an eye on software updates for the applications listed on our site and follow recent news about providers that we recommend. It's hard to keep up with the fast pace of the internet, but we try our best. If you spot an error, think a provider should not be listed, notice a qualified provider is missing, believe a browser plugin is no longer the best choice, or uncover any other issue, please let us know." HOMEPAGE_DESCRIPTION="A socially motivated website which provides information about protecting your online data privacy and security." HOMEPAGE_RSS_CHANGELOG_LINK="https://discuss.privacyguides.net/c/site-development/changelog/9.rss" HOMEPAGE_RSS_CHANGELOG_TITLE="Privacy Guides release changelog" @@ -56,3 +52,5 @@ SOCIAL_TOR_SITE="Hidden service" THEME_AUTO="Switch to system theme" THEME_DARK="Switch to dark mode" THEME_LIGHT="Switch to light mode" +TRANSLATION_NOTICE="You're viewing the $LANG copy of Privacy Guides, translated by our fantastic language team on Crowdin. If you notice an error, or see any untranslated sections on this page, please consider helping out!" +TRANSLATION_NOTICE_CTA="Visit Crowdin" diff --git a/theme/home.html b/theme/home.html index 83450b979c..ea62220608 100644 --- a/theme/home.html +++ b/theme/home.html @@ -52,14 +52,14 @@

{{ homepage.hero.header }}

{{ page.content }}
-

We need you! Here's how to get involved:

-

- - - - - -

-

It's important for a website like Privacy Guides to always stay up-to-date. We need our audience to keep an eye on software updates for the applications listed on our site and follow recent news about providers that we recommend. It's hard to keep up with the fast pace of the internet, but we try our best. If you spot an error, think a provider should not be listed, notice a qualified provider is missing, believe a browser plugin is no longer the best choice, or uncover any other issue, please let us know.

+ {% for cta in homepage.cta %} +

{{ cta.title }}

+ {% for icon in cta.links %} + + {% include ".icons/" ~ icon.icon ~ ".svg" %} + + {% endfor %} +

{{ cta.description }}

+ {% endfor %}
{% endblock %} diff --git a/theme/partials/content.html b/theme/partials/content.html index 2f51112259..47c86da2ec 100644 --- a/theme/partials/content.html +++ b/theme/partials/content.html @@ -47,15 +47,16 @@

{{ page.title | d(config.site_name, true)}}

{% include "partials/feedback.html" %} -{% if config.theme.language == "en" %} +{% set translation_notice = config.extra.privacy_guides.translation_notice %} +{% if config.theme.language == "fr" %}

Share this website and spread privacy knowledge

Copy this text to easily share Privacy Guides with your friends and family on any social network!

-{% elif config.extra.translation_notice %} +{% elif translation_notice %}
-

{{ config.extra.translation_notice }} {{ config.extra.translation_notice_cta }}

-

You're viewing the {{ config.extra.translation_notice_language }} copy of Privacy Guides, translated by our fantastic language team on Crowdin. If you notice an error, or see any untranslated sections on this page, please consider helping out!

+

{{ translation_notice.notice }} {{ translation_notice.cta }}

+

You're viewing the {{ translation_notice.language }} copy of Privacy Guides, translated by our fantastic language team on Crowdin. If you notice an error, or see any untranslated sections on this page, please consider helping out!

{% endif %} diff --git a/theme/partials/footer.html b/theme/partials/copyright.html similarity index 61% rename from theme/partials/footer.html rename to theme/partials/copyright.html index 600105c5c8..4ca43a5fb5 100644 --- a/theme/partials/footer.html +++ b/theme/partials/copyright.html @@ -1,6 +1,5 @@ - - + {% endif %} +