From d3e775343b14c8d32750e1fc3b8fc3498e9fbe00 Mon Sep 17 00:00:00 2001 From: Thibault Martin Date: Wed, 3 May 2023 18:13:10 +0200 Subject: [PATCH] Add descriptions on most pages (#1768) * Add descriptions on most page * Typo Co-authored-by: Marcel * Remove pause mention * Don't mention m.org in Try Matrix's meta description --------- Co-authored-by: Marcel --- content/about/index.md | 5 +++++ content/blog/_index.md | 5 +++++ content/docs/chat_basics/matrix-for-im/_index.md | 4 ++++ .../docs/chat_basics/private-group-chat/_index.md | 5 +++++ content/docs/chat_basics/public-rooms/_index.md | 5 +++++ .../docs/communities/getting-started/_index.md | 4 ++++ content/docs/communities/moderation/_index.md | 5 +++++ .../communities/switching-providers/_index.md | 5 +++++ content/docs/legacy/_index.md | 4 ++++ .../matrix-concepts/elements-of-matrix/_index.md | 5 +++++ .../matrix-concepts/rooms_and_events/_index.md | 5 +++++ content/ecosystem/hosting/index.md | 3 +++ content/podcasts/index.md | 5 +++++ content/try-matrix.md | 4 ++++ templates/ecosystem/bridges.html | 15 +++++++++------ templates/ecosystem/client.html | 3 +++ templates/ecosystem/clients.html | 1 + templates/ecosystem/hosting.html | 10 +++++----- templates/ecosystem/sdks.html | 1 + templates/ecosystem/servers.html | 1 + templates/index.html | 2 ++ templates/page.html | 5 +++++ templates/podcasts.html | 2 +- templates/section.html | 5 +++++ 24 files changed, 97 insertions(+), 12 deletions(-) diff --git a/content/about/index.md b/content/about/index.md index eae4a884c..096b4daf8 100644 --- a/content/about/index.md +++ b/content/about/index.md @@ -1,6 +1,11 @@ +++ title = "About Matrix" aliases = ["/foundation/"] +extra.meta_description = """ +The Matrix.org Foundation is overseen by its Guardians. The Spec Core Team works +on maintaining the Matrix Specification in accordance with the Foundation rules +and manifesto. +""" +++ ## Governance diff --git a/content/blog/_index.md b/content/blog/_index.md index bfb9e7182..0ee724949 100644 --- a/content/blog/_index.md +++ b/content/blog/_index.md @@ -4,4 +4,9 @@ template = "blog.html" page_template = "post.html" sort_by = "date" paginate_by = 10 +extra.meta_description = """ +The Matrix.org Foundation blod is where the Matrix Foundation and Community +post updates on their activity. Every Friday evening they publish This Week In +Matrix, a digest of the past week activity. +""" +++ diff --git a/content/docs/chat_basics/matrix-for-im/_index.md b/content/docs/chat_basics/matrix-for-im/_index.md index db7d55a2c..22570806b 100644 --- a/content/docs/chat_basics/matrix-for-im/_index.md +++ b/content/docs/chat_basics/matrix-for-im/_index.md @@ -5,6 +5,10 @@ template = "docs/with_menu.html" aliases = ["/docs/", "/docs/chat_basics/"] [extra] updated = "2022-10-18T16:00:00Z" +meta_description = """ +Matrix is an open protocol many apps can use for secure, decentralised +communications. Your first steps with Matrix start here. +""" +++ ## What is it? diff --git a/content/docs/chat_basics/private-group-chat/_index.md b/content/docs/chat_basics/private-group-chat/_index.md index 0aa6df71b..68ff0ee60 100644 --- a/content/docs/chat_basics/private-group-chat/_index.md +++ b/content/docs/chat_basics/private-group-chat/_index.md @@ -6,6 +6,11 @@ template = "docs/with_menu.html" emoji = "πŸ§‘β€πŸ€β€πŸ§‘" tile = "I want to create a private group chat" updated = "2022-10-18T16:00:00Z" +meta_description = """ +Matrix can be used to create small private group chats. It can be used to send +messages, invite others, but it also has moderation features to keep the group +safe. +""" +++ The simplest way to get started is to create a private group chat so you can diff --git a/content/docs/chat_basics/public-rooms/_index.md b/content/docs/chat_basics/public-rooms/_index.md index 7434d0c27..b533ddbca 100644 --- a/content/docs/chat_basics/public-rooms/_index.md +++ b/content/docs/chat_basics/public-rooms/_index.md @@ -6,6 +6,11 @@ template = "docs/with_menu.html" emoji = "🌐" tile = "I want to join public conversations" updated = "2022-10-18T16:00:00Z" +meta_description = """ +Matrix is often use for public online discussions. Being an interoperable +protocol, it allows people using different providers to talk together online, +safely. +""" +++ When you want to join larger public conversations, you have three major options diff --git a/content/docs/communities/getting-started/_index.md b/content/docs/communities/getting-started/_index.md index f965e1d52..1d72a2dd9 100644 --- a/content/docs/communities/getting-started/_index.md +++ b/content/docs/communities/getting-started/_index.md @@ -7,6 +7,10 @@ aliases = ["/docs/communities/"] emoji = "πŸ‘ͺ" tile = "Create a cozy place on Matrix for your community or organisation" updated = "2022-11-18T09:50:00Z" +meta_description = """ +Everyone can start their community on Matrix by creating a Matrix Space. +Community Managers can then tweak the Space to their needs. +""" +++ We strongly recommend getting familiar with Matrix as an individual. It's easy diff --git a/content/docs/communities/moderation/_index.md b/content/docs/communities/moderation/_index.md index d733c9826..44d0fb095 100644 --- a/content/docs/communities/moderation/_index.md +++ b/content/docs/communities/moderation/_index.md @@ -6,6 +6,11 @@ weight = 200 emoji = "πŸ›‘οΈ" tile = "I want to deploy moderation tools" updated = "2023-01-25T06:43:00Z" +meta_description = """ +Matrix allows communities to stay safe thanks to moderation tools. Mjolnir is +the recommended solution for community managers who want to fight abuse on +Matrix. +""" +++ ## Power levels diff --git a/content/docs/communities/switching-providers/_index.md b/content/docs/communities/switching-providers/_index.md index 8ce23fa02..d1a08efc3 100644 --- a/content/docs/communities/switching-providers/_index.md +++ b/content/docs/communities/switching-providers/_index.md @@ -6,6 +6,11 @@ weight = 300 emoji = "🏑" tile = "I want to get my own homeserver" updated = "2023-01-30T14:00:00Z" +meta_description = """ +Even after creating a community on a provider, it's possible to switch to +another one. This allows communities to get more sovereignty on their +conversations, and to connect them to their own systems. +""" +++ ## Why switching providers? diff --git a/content/docs/legacy/_index.md b/content/docs/legacy/_index.md index a08d8fd70..3225da574 100644 --- a/content/docs/legacy/_index.md +++ b/content/docs/legacy/_index.md @@ -7,6 +7,10 @@ weight = 900 [extra] emoji = "πŸ•ΈοΈ" tile = "Legacy documentation" +meta_description = """ +This section contains all the documentation previously published that is no +longer relevant or maintained. It is kept online for archive purposes. +""" +++ This section contains all the outdated documentation from the former matrix.org diff --git a/content/docs/matrix-concepts/elements-of-matrix/_index.md b/content/docs/matrix-concepts/elements-of-matrix/_index.md index 0a0253c58..c7d87ba8c 100644 --- a/content/docs/matrix-concepts/elements-of-matrix/_index.md +++ b/content/docs/matrix-concepts/elements-of-matrix/_index.md @@ -5,6 +5,11 @@ template = "docs/with_menu.html" aliases = ["/docs/matrix-concepts", "/docs/technical/"] [extra] updated = "2023-02-08T08:00:00Z" +meta_description = """ +Matrix relies on homeservers to connect clients together. Appservices are +pieces of software that can bridge Matrix and third-party platforms together. +The Matrix Specification defines the interactions between all those. +""" +++ Matrix works like email, but for instant messaging. People need to use a client diff --git a/content/docs/matrix-concepts/rooms_and_events/_index.md b/content/docs/matrix-concepts/rooms_and_events/_index.md index b96d708ba..7f1700a88 100644 --- a/content/docs/matrix-concepts/rooms_and_events/_index.md +++ b/content/docs/matrix-concepts/rooms_and_events/_index.md @@ -4,6 +4,11 @@ weight = 200 template = "docs/with_menu.html" [extra] updated = "2023-02-23T08:00:00Z" +meta_description = """ +Matrix relies on rooms to distribute events across servers and clients. Rooms +have a hierarchy based on power levels. Each homeserver has its own copy of all +the rooms all their users belong to. +""" +++ Users on a server can send *events* into *rooms*. An event is a particular json diff --git a/content/ecosystem/hosting/index.md b/content/ecosystem/hosting/index.md index d815dc9a0..22b67e7cf 100644 --- a/content/ecosystem/hosting/index.md +++ b/content/ecosystem/hosting/index.md @@ -2,6 +2,9 @@ title = "Hosting" template = "ecosystem/hosting.html" weight = 4 +extra.summary = """ +Everyone can host their Matrix server, but not everybody wants. Those are the providers the Matrix Foundation knows about. +""" +++ ## Why not matrix.org? diff --git a/content/podcasts/index.md b/content/podcasts/index.md index d538c0450..c7756a9b3 100644 --- a/content/podcasts/index.md +++ b/content/podcasts/index.md @@ -2,5 +2,10 @@ title = "Podcasts" template = "podcasts.html" aliases = ["/matrixlive/"] +extra.meta_description = """ +Matrix Live is the weekly show produced by the Matrix Foundation to talk about +the latest Matrix news. Open Tech Will Save Us was a show to talk about the +importance of open standards and open source software for social good. +""" +++ diff --git a/content/try-matrix.md b/content/try-matrix.md index 63fd24b6d..12580f38e 100644 --- a/content/try-matrix.md +++ b/content/try-matrix.md @@ -2,4 +2,8 @@ title = "Try Matrix" template = "try-matrix.html" extra.summary = "Join the Matrix ecosystem!" +extra.meta_description = """ +To try Matrix, pick a client, pick a server, register an account and start +chatting! +""" +++ diff --git a/templates/ecosystem/bridges.html b/templates/ecosystem/bridges.html index 65ec32c8e..bb1857e61 100644 --- a/templates/ecosystem/bridges.html +++ b/templates/ecosystem/bridges.html @@ -1,4 +1,7 @@ {% extends "section.html" %} +{% block head_extra %} + +{% endblock head_extra %} {% block content %}
@@ -12,23 +15,23 @@ {{ section.content | safe }}
- {% for subsection_path in section.subsections %} - {% set subsection = get_section(path=subsection_path) %} - {% set bridges_data = load_data(path=subsection.path~"bridges.toml") %} + {% for subsection_path in section.subsections %} + {% set subsection = get_section(path=subsection_path) %} + {% set bridges_data = load_data(path=subsection.path~"bridges.toml") %}

{{ subsection.title }}

{% if bridges_data.bridges %} - {{ bridges_data.bridges | length }} bridge{% if bridges_data.bridges | length > 1 %}s{% endif %} + {{ bridges_data.bridges | length }} bridge{% if bridges_data.bridges | length > 1 %}s{% endif %} {% else %} - No bridge + No bridge {% endif %}

- {% endfor %} + {% endfor %}
diff --git a/templates/ecosystem/client.html b/templates/ecosystem/client.html index bc45db936..794e81518 100644 --- a/templates/ecosystem/client.html +++ b/templates/ecosystem/client.html @@ -1,5 +1,8 @@ {% extends "page.html" %} {% import "macros/clients.html" as clients %} +{% block head_extra %} +", to="") | replace(from="

", to="") }}"> +{% endblock head_extra %} {% block content %} {% if page.extra.thumbnail %} {% set thumbnail = page.extra.thumbnail %} diff --git a/templates/ecosystem/clients.html b/templates/ecosystem/clients.html index dacaac06b..80fd4d615 100644 --- a/templates/ecosystem/clients.html +++ b/templates/ecosystem/clients.html @@ -2,6 +2,7 @@ {% import "macros/clients.html" as clients %} {% import "macros/client_details.html" as client_details %} {% block head_extra %} + diff --git a/templates/ecosystem/hosting.html b/templates/ecosystem/hosting.html index 00b21a605..f89f6245d 100644 --- a/templates/ecosystem/hosting.html +++ b/templates/ecosystem/hosting.html @@ -1,12 +1,12 @@ {% extends "page.html" %} +{% block head_extra %} + +{% endblock head_extra %} {% block content %}
-

Hosting

-

- Everyone can host their Matrix server, but not everybody wants. - Those are the providers the Matrix Foundation knows about. -

+

{{ page.title }}

+

{{ page.extra.summary }}

diff --git a/templates/ecosystem/sdks.html b/templates/ecosystem/sdks.html index 00df76dd3..80354e31b 100644 --- a/templates/ecosystem/sdks.html +++ b/templates/ecosystem/sdks.html @@ -1,5 +1,6 @@ {% extends "page.html" %} {% block head_extra %} + diff --git a/templates/ecosystem/servers.html b/templates/ecosystem/servers.html index 00dbaa255..39af4ce0d 100644 --- a/templates/ecosystem/servers.html +++ b/templates/ecosystem/servers.html @@ -1,5 +1,6 @@ {% extends "page.html" %} {% block head_extra %} + diff --git a/templates/index.html b/templates/index.html index 55bd5983f..a1c3a9467 100644 --- a/templates/index.html +++ b/templates/index.html @@ -1,5 +1,7 @@ {% extends "skel.html" %} {% block head_extra %} + {% endblock head_extra %} {% block content %} diff --git a/templates/page.html b/templates/page.html index 12d7916d5..60938c1f8 100644 --- a/templates/page.html +++ b/templates/page.html @@ -1,5 +1,10 @@ {% extends "skel.html" %} {% block html_title %}Matrix.org - {{ page.title }}{% endblock html_title %} +{% block head_extra %} +{% if page.extra.meta_description %} + +{% endif %} +{% endblock head_extra %} {% block content %}
diff --git a/templates/podcasts.html b/templates/podcasts.html index e6f956ded..5ef4647fc 100644 --- a/templates/podcasts.html +++ b/templates/podcasts.html @@ -1,4 +1,4 @@ -{% extends "index.html" %} +{% extends "page.html" %} {% block content %} {% set matrix_live = load_data(path="partials/podcasts/matrix_live.md") %} {% set otwsu = load_data(path="partials/podcasts/otwsu.md") %} diff --git a/templates/section.html b/templates/section.html index ffb24100b..2d5b5f1f2 100644 --- a/templates/section.html +++ b/templates/section.html @@ -1,5 +1,10 @@ {% extends "skel.html" %} {% block html_title %}Matrix.org - {{ section.title }}{% endblock html_title %} +{% block head_extra %} +{% if section.extra.meta_description %} + +{% endif %} +{% endblock head_extea %} {% block content %}