New help page

master
rubenwardy 2021-09-18 23:27:46 +01:00
parent cc65a9f3fd
commit c600e0f673
11 changed files with 133 additions and 34 deletions

13
_data/help.yml Normal file
View File

@ -0,0 +1,13 @@
links:
# - id: tutorial
# url: tutorial/
# icon: flag
- id: faq
url: faq/
icon: life-ring
- id: get_involved
url: /en/get_involved/
icon: users

View File

@ -110,3 +110,10 @@ widgets.yearprogress: "<b>Year Progress</b>: shows the progress through the year
widgets.currencies: "<b>Currencies</b>: shows exchange rates, supporting forex currencies and crypto."
widgets.spaceflight: "<b>Upcoming Space Flights</b>"
widgets.more: "and more: buttons, images, HTML, and iframes."
help.links.tutorial.title: Getting Started
help.links.tutorial.desc: Learn how to set up and use Renewed Tab
help.links.faq.title: Problems and Questions
help.links.faq.desc: Frequently Asked Questions
help.links.get_involved.title: Get Involved
help.links.get_involved.desc: Chat with the developers and other users

View File

@ -2,6 +2,7 @@
{% assign lang = pathsplit[0] %}
{% assign l = site.data.locale[lang] | default: site.dat.locale.en %}
{% assign en = site.data.locale.en.index %}
{% assign oldSegment = "/" | append: lang | append: "/" %}
<nav class="navbar is-primary">
<div class="container">
@ -24,7 +25,7 @@
{% for item in site.data.navbar %}
{% assign title_id = "nav." | append: item.id %}
{% assign title = l.index[title_id] | default: en[title_id] %}
{% assign url = item.url | replace: "en", lang %}
{% assign url = item.url | replace: "/en/", oldSegment %}
<a class="navbar-item {% if url == page.url %}active{% endif %}" href="{{ url }}">
{{ title }}
</a>
@ -39,7 +40,6 @@
</a>
<div class="navbar-dropdown">
{% assign oldSegment = "/" | append: lang | append: "/" %}
{% for other in site.data.languages %}
{% assign newSegment = "/" | append: other.code | append: "/" %}

30
_layouts/help.html Normal file
View File

@ -0,0 +1,30 @@
---
layout: article
---
{% assign pathsplit = page.path | split: '/' %}
{% assign lang = pathsplit[0] %}
{% assign l = site.data.locale[lang] %}
{% assign en = site.data.locale.en.index %}
<div class="columns">
{% for link in site.data.help.links %}
{% assign title_id = "help.links." | append: link.id | append: ".title" %}
{% assign desc_id = "help.links." | append: link.id | append: ".desc" %}
{% assign title = l.index[title_id] | default: en[title_id] %}
{% assign desc = l.index[desc_id] | default: en[desc_id] %}
<div class="column">
<a href="{{ link.url }}">
<div class="box has-text-centered">
<i class="fas fa-{{ link.icon }} is-size-1 mb-4"></i>
<h3 class="my-2">{{ title }}</h3>
<div>{{ desc }}</div>
</div>
</a>
</div>
{% endfor %}
</div>
{{ content }}

View File

@ -95,7 +95,7 @@ layout: default
{% assign title_id = "features." | append: item.id | append: ".title" %}
{% assign desc_id = "features." | append: item.id | append: ".desc" %}
{% assign title = l.index[title_id] | default: en[title_id] %}
{% assign desc = l.index[desc_id] | default: en[title_id] %}
{% assign desc = l.index[desc_id] | default: en[desc_id] %}
{% unless item.image %}
<div class="column is-one-third content">

View File

@ -1,15 +1,28 @@
---
title: Help and FAQ
title: Frequently Asked Questions
layout: article
redirect_from:
- /help/
---
# Help and FAQ
<a href="/en/help/">
<i class="fas fa-arrow-left"></i>
Back to help
</a>
## Frequently Asked Questions
# Frequently Asked Questions <!-- omit in toc -->
### How do I enable the blur on Firefox?
- [How do I enable the blur on Firefox?](#how-do-i-enable-the-blur-on-firefox)
- [How do I show the bookmarks bar only on the New Tab page?](#how-do-i-show-the-bookmarks-bar-only-on-the-new-tab-page)
- [How can I place widgets outside of the grid / at the bottom of the screen?](#how-can-i-place-widgets-outside-of-the-grid--at-the-bottom-of-the-screen)
- [Why does the extension request to read all the data for a website?](#why-does-the-extension-request-to-read-all-the-data-for-a-website)
- [Why does a background that I've blocked still appear?](#why-does-a-background-that-ive-blocked-still-appear)
- [Why isn't the background image appearing?](#why-isnt-the-background-image-appearing)
- [Why don't you support browser sync?](#why-dont-you-support-browser-sync)
- [Why don't you support X browser?](#why-dont-you-support-x-browser)
- [Why do I get an error when entering a custom URL in the web version?](#why-do-i-get-an-error-when-entering-a-custom-url-in-the-web-version)
- [How do I add custom widgets?](#how-do-i-add-custom-widgets)
- [How can I get in contact?](#how-can-i-get-in-contact)
## How do I enable the blur on Firefox?
Edit: Firefox has broken support for this feature for now.
Hopefully it'll be readded in the future.
@ -25,7 +38,7 @@ Hopefully it'll be readded in the future.
Please note that you may get visual glitches with this, it is an unstable
Firefox feature, which is why it's not enabled by default. -->
### How do I show the bookmarks bar only on the New Tab page?
## How do I show the bookmarks bar only on the New Tab page?
On Chrome, there's no way to show the **builtin** bookmarks bar only
on the New Tab page. However, Renewed Tab provides its own bookmarks bar which
@ -36,7 +49,7 @@ Only Show on New Tab.
![Only show on new tab](/static/images/help/firefox_bookmarks.png)
### How can I place widgets outside of the grid / at the bottom of the screen?
## How can I place widgets outside of the grid / at the bottom of the screen?
Renewed Tab requires all widgets to be placed on the grid. This is great for
the User Experience, as it's simple, but makes it harder to do certain things.
@ -44,7 +57,7 @@ the User Experience, as it's simple, but makes it harder to do certain things.
To make a widget appear to be at the bottom of the screen, you can use the
Invisible widget to add vertical spacing between widgets.
### Why does the extension request to read all the data for a website?
## Why does the extension request to read all the data for a website?
Some widgets, such as Feed, require loading information from a URL.
Web browsers tend to have strict permission systems, such that a browser
@ -68,7 +81,7 @@ Example messages:
> It wants to:
> - Access your data for feeds.bbci.co.uk
### Why does a background that I've blocked still appear?
## Why does a background that I've blocked still appear?
The Renewed Tab API server only has 4 images available to choose from at a time.
If you've blocked a lot of images, then it's possible that you may end up with
@ -77,7 +90,7 @@ first image will be used.
The reason this is done is to avoid hitting the Unsplash API too much.
### Why isn't the background image appearing?
## Why isn't the background image appearing?
Extensions like DarkReader can conflict with the background image, you can
disable it per-site.
@ -85,7 +98,7 @@ disable it per-site.
Alternatively, it may be a connection issue with the Renewed Tab API or unsplash,
or a configuration issue.
### Why don't you support browser sync?
## Why don't you support browser sync?
Chrome and Firefox sync is limited to 8KB per key. It is common for components like notes
to exceed this limit, which makes it impractical to support sync.
@ -93,7 +106,7 @@ to exceed this limit, which makes it impractical to support sync.
You can use Settings (<i class="fas fa-cog"></i>) > Import / Export to share
your setup between browsers.
### Why don't you support X browser?
## Why don't you support X browser?
We only support the latest 2 versions of Firefox and Chrome; it is hard to test
and provide support for every browser.
@ -114,7 +127,7 @@ able to help. However, we may accept patches/PRs to fix issues on unsupported
platforms as long as it doesn't introduce architectural problems, and the
problem is not due to the browser incorrectly implementing web standards.
### Why do I get an error when entering a custom URL in the web version?
## Why do I get an error when entering a custom URL in the web version?
If you try to enter a custom URL that is not allowed in the web version, you
will get the following error:
@ -141,8 +154,7 @@ restriction
Note: If you get the error whilst using the browser extension, there's something
_wrong_. Please report it below.
### How do I add custom widgets?
## How do I add custom widgets?
We would really like to support custom widgets. But unfortunately, it's not
possible due to the developer terms that Firefox and Chrome enforce on extension
@ -155,8 +167,7 @@ We'll continue to look for alternatives for this, as we'd really like to allow i
What you can do is use an IFrame widget to show a webpage as if it were a widget.
You can use this to create custom widgets.
## Feature Requests, Bug Reports, and Support
## How can I get in contact?
Making an issue on the Issue Tracker is the preferred way of discussing
Renewed Tab bugs and feature requests.

19
en/help/index.md Normal file
View File

@ -0,0 +1,19 @@
---
title: Help
layout: help
redirect_from:
- /help/
---
### Top Questions
- [How do I enable the blur on Firefox?](faq/#how-do-i-enable-the-blur-on-firefox)
- [How do I show the bookmarks bar only on the New Tab page?](faq/#how-do-i-show-the-bookmarks-bar-only-on-the-new-tab-page)
- [How can I place widgets outside of the grid / at the bottom of the screen?](faq/#how-can-i-place-widgets-outside-of-the-grid--at-the-bottom-of-the-screen)
- [Why does the extension request to read all the data for a website?](faq/#why-does-the-extension-request-to-read-all-the-data-for-a-website)
- [Why does a background that I've blocked still appear?](faq/#why-does-a-background-that-ive-blocked-still-appear)
- [Why isn't the background image appearing?](faq/#why-isnt-the-background-image-appearing)
- [Why don't you support browser sync?](faq/#why-dont-you-support-browser-sync)
- [Why don't you support X browser?](faq/#why-dont-you-support-x-browser)
- [Why do I get an error when entering a custom URL in the web version?](faq/#why-do-i-get-an-error-when-entering-a-custom-url-in-the-web-version)
- [How do I add custom widgets?](faq/#how-do-i-add-custom-widgets)

View File

@ -1,13 +1,25 @@
---
title: Ayuda y FAQ
layout: article
redirect_from:
- /es/help/
---
# Ayuda y FAQ
# Preguntas Frecuentes <!-- omit in toc -->
## Preguntas Frecuentes
### ¿Cómo habilito el desenfoque en Firefox?
- [¿Cómo habilito el desenfoque en Firefox?](#cómo-habilito-el-desenfoque-en-firefox)
- [¿Cómo puedo ubicar widgets fuera de la cuadrícula / en la parte inferior de la pantalla?](#cómo-puedo-ubicar-widgets-fuera-de-la-cuadrícula--en-la-parte-inferior-de-la-pantalla)
- [¿Por qué la extensión solicita leer todos los datos de un sitio web?](#por-qué-la-extensión-solicita-leer-todos-los-datos-de-un-sitio-web)
- [¿Por qué sigue apareciendo un fondo que he bloqueado?](#por-qué-sigue-apareciendo-un-fondo-que-he-bloqueado)
- [¿Por qué no aparece la imagen de fondo?](#por-qué-no-aparece-la-imagen-de-fondo)
- [¿Por qué no admite sincronización de navegador?](#por-qué-no-admite-sincronización-de-navegador)
- [¿Por qué no está disponible para X navegador?](#por-qué-no-está-disponible-para-x-navegador)
- [¿Por qué me sale un error al ingresar una URL personalizada en la versión web?](#por-qué-me-sale-un-error-al-ingresar-una-url-personalizada-en-la-versión-web)
- [Solicitudes de Funciones, Informe de Errores, y Asistencia](#solicitudes-de-funciones-informe-de-errores-y-asistencia)
## ¿Cómo habilito el desenfoque en Firefox?
El desenfoque requiere activar una característica experimental en Firefox, llamada
`backdrop-filter`:
@ -19,7 +31,8 @@ El desenfoque requiere activar una característica experimental en Firefox, llam
Por favor tenga en cuenta que puede experimentar problemas visuales con esto, ya que es una característica inestable de Firefox, por lo cual no está habilitada por defecto.
### ¿Cómo puedo ubicar widgets fuera de la cuadrícula / en la parte inferior de la pantalla?
## ¿Cómo puedo ubicar widgets fuera de la cuadrícula / en la parte inferior de la pantalla?
Renewed Tab requiere que todos los widgets estén en la cuadrícula. Esto es genial para
la experiencia del usuario, ya que es simple, pero dificulta hacer ciertas cosas.
@ -27,7 +40,8 @@ la experiencia del usuario, ya que es simple, pero dificulta hacer ciertas cosas
Para hacer que un widget parezca estar la parte inferior de la pantalla,
puede usar el widget invisible para agregar espacio vertical entre widgets.
### ¿Por qué la extensión solicita leer todos los datos de un sitio web?
## ¿Por qué la extensión solicita leer todos los datos de un sitio web?
Algunos widgets, como Feed, requieren que se cargue información desde una URL.
Los navegadores web tienden a tener sistemas de permisos estrictos, por lo
@ -51,7 +65,8 @@ Mensajes de ejemplo:
> Quiere:
> - Acceder a tus datos para feeds.bbci.co.uk
### ¿Por qué sigue apareciendo un fondo que he bloqueado?
## ¿Por qué sigue apareciendo un fondo que he bloqueado?
El servidor de API de Renewed Tab solo tiene 4 imágenes disponibles para elegir a la vez.
Si ha bloqueado muchas imágenes, es posible que termine con que todas
@ -60,7 +75,8 @@ se utilizará la primer imagen.
La razón por la que se hace esto es para evitar llamar demasiado la API de Unsplash.
### ¿Por qué no aparece la imagen de fondo?
## ¿Por qué no aparece la imagen de fondo?
Extensiones como DarkReader pueden tener conflictos con la imagen de fondo,
usted puede deshabilitarlas por sitio.
@ -68,7 +84,8 @@ usted puede deshabilitarlas por sitio.
Alternativamente, puede ser un problema de conexión con la API de Renewed Tab o Unsplash,
o un problema de configuración.
### ¿Por qué no admite sincronización de navegador?
## ¿Por qué no admite sincronización de navegador?
La sincronización de Chrome y Firefox está limitada a 8 KB por clave.
Es común que componentes como las notas excedan este límite,
@ -76,7 +93,8 @@ lo que hace que no sea práctico admitir la sincronización.
Puede usar Ajustes (<i class="fas fa-cog"></i>) > Importar / Exportar para compartir su configuración entre navegadores.
### ¿Por qué no está disponible para X navegador?
## ¿Por qué no está disponible para X navegador?
Solo admitimos las últimas 2 versiones de Firefox y Chrome; es dificil probar
y brindar soporte para todos los navegadores.
@ -96,7 +114,8 @@ Sin embargo, podemos aceptar parches / PR para solucionar problemas en
plataformas no compatibles siempre que no introduzcan problemas de arqutectura,
y el problema no se deba a que el navegador implemente incorrectamente los estándares web.
### ¿Por qué me sale un error al ingresar una URL personalizada en la versión web?
## ¿Por qué me sale un error al ingresar una URL personalizada en la versión web?
Si intenta ingresar una URL personalizada que no está permitida en la versión web,
obtendrá el siguiente error:

View File

@ -55,7 +55,7 @@ layout: article
<div class="buttons">
<a class="button is-primary" href="/help/">
<i class="fas fa-question-circle mr-2"></i>
Frequently Asked Questions
Help / FAQ
</a>
<a href="https://gitlab.com/renewedtab/renewedtab/-/issues" class="button">
<i class="fab fa-gitlab mr-2"></i>

View File

@ -142,7 +142,7 @@ layout: article
<div class="buttons">
<a class="button is-primary" href="/help/">
<i class="fas fa-question-circle mr-2"></i>
Frequently Asked Questions
Help / FAQ
</a>
<a href="https://rubenwardy.com/contact/" class="button">
<i class="fas fa-envelope mr-2"></i>

View File

@ -91,7 +91,7 @@ reasons:
<p>
<a class="button is-primary" href="/help/">
<i class="fas fa-question-circle mr-2"></i>
Frequently Asked Questions
Help / FAQ
</a>
<a href="https://gitlab.com/renewedtab/renewedtab/-/issues" class="button">
<i class="fab fa-gitlab mr-2"></i>