Increasing the prominence of documentation / Mayor protagonismo de la documentación

[ben-agaric]

[Español abajo]

Starting a new thread after, at a mid-point meeting of the second try at onboarding Gertrude Brown Community Land Trust, i was ctrl+F searching the https://mayfirst.coop homepage in semi-desperation and coming up with nothing.

(I was having internet connectivity issues, and they figured out on their own how to set up an identity in Roundcube so they can send e-mail with their domain name (rather than the mayfirst .org domain name); this webmail does not appear to be documented yet anyway and of course the ideal would be if we could automate identity setup.)

I do think it is time to have a Documentation link on May First’s main website go to https://help.mayfirst.org

Would it be possible for some old-timers like me to go through how-to – Support and faq – Support and services – Support and then set up redirects to relevant pages in the new documentation (and helping ensure nothing crucial is missing)?

Some key links i could gather on the modern documentation effort:

https://comment.mayfirst.org/t/introduction-to-documentation-project-introduccion-al-proyecto-de-documentacion/2615

https://comment.mayfirst.org/t/borrador-estructura-documentacion-documentation-structure-draft/2216/8

Approaches to writing good documentation / Estrategías para escribir buena documentación

Start with what the reader needs This live presentation by Beth Aitman offers up some useful rules of thumb for writing a good piece of documentation. These recommendations seem most applicable to how-to’s and tutorials. I’ve summarized what I felt were the main points here. 1. Start with what the reader needs help a reader to achieve a goal - what does your reader need to get out of it? write only the stuff down that helps them with that. don’t include stuff just because it’s connected a…

---

[Traducido por máquina en su mayor parte, lo siento]

Empezar un nuevo hilo después de que, en una reunión a mitad de camino del segundo intento de incorporación de Gertrude Brown Community Land Trust, yo estaba ctrl+F buscando en la página de inicio de https://mayfirst.coop con semi desesperación y sin encontrar nada.

(Estaba teniendo problemas de conectividad a Internet, y ellas averiguaron por su cuenta cómo configurar una identidad en Roundcube para poder enviar correo electrónico con su nombre de dominio (en lugar del nombre de dominio mayfirst .org); este webmail no parece estar documentado todavía de todos modos y, por supuesto, lo ideal sería que pudiéramos automatizar la configuración de la identidad).

Creo que ya es hora de que haya un enlace de documentación en el sitio web principal de May First que vaya a https://help.mayfirst.org.

¿Sería posible que algunos veteranos como yo revisaran how-to – Support, faq – Support y services – Support y luego redirigieran a las páginas relevantes de la nueva documentación (y ayudaran a asegurar que no falta nada crucial)?

Algunos enlaces clave que pude reunir sobre el esfuerzo de la documentación moderna:

https://comment.mayfirst.org/t/introduction-to-documentation-project-introduccion-al-proyecto-de-documentacion/2615

https://comment.mayfirst.org/t/borrador-estructura-documentacion-documentation-structure-draft/2216/8

Approaches to writing good documentation / Estrategías para escribir buena documentación

Start with what the reader needs This live presentation by Beth Aitman offers up some useful rules of thumb for writing a good piece of documentation. These recommendations seem most applicable to how-to’s and tutorials. I’ve summarized what I felt were the main points here. 1. Start with what the reader needs help a reader to achieve a goal - what does your reader need to get out of it? write only the stuff down that helps them with that. don’t include stuff just because it’s connected a…

[vargarquista]

Estoy de acuerdo que necesitamos darle más visibilidad a la documentación, pero también tu comentario me parece que muestra que no estamos siendo muy eficientes para que la gente, una vez en help.mayfirst.org, encuentre lo que necesite. Creo que lo que buscabas si está, se encuentra acá: Cómo añadir o cambiar la identidad para envíar correo electrónico | May First Documentation Wiki

Deberíamos tenerlo linkeado desde la página de mail que es la que colocas en tu pregunta.

Pero si, de acuerdo que debemos dar un paso adelante en este proceso de documentación y tu ayuda sería de mucha utilidad.

Saludos!

---

I agree that we need to give more visibility to the documentation, but also your comment seems to me to show that we are not being very efficient for people, once on help.mayfirst.org, to find what they need. I think what you were looking for is here: How to change or add an email sending identity | May First Documentation Wiki

We should have it linked from the mail page which is the one you put in your question.

But yes, I agree that we should take a step forward in this documentation process and your help would be very useful.

Greetings!

Translated with DeepL.com (free version)

[jamie]

Oh wow - I also agree that we need better links. Help is on the way! We are in the middle of a multi-month process to re-design our web site that will hopefully have way better navigation.

In the mean time, I just updated our wobbly existing web site with links to the help page in the members section and in the footer.

---

Vaya, yo también estoy de acuerdo en que necesitamos mejores enlaces. ¡La ayuda está en camino! Estamos en medio de un proceso de varios meses para rediseñar nuestro sitio web que esperamos que tenga una mejor navegación.

Mientras tanto, acabo de actualizar nuestro tambaleante sitio web actual con enlaces a la página de ayuda en la sección de miembros y en el pie de página.