Base de conocimiento

Artículos y redacción

Artículos y redacción

La Base de conocimiento es donde tu equipo guarda sus runbooks, procedimientos y notas: la documentación de tu propio parque. Es distinta de este Manual: el Manual documenta lazyit en sí, la Base de conocimiento documenta tus servidores, tus aplicaciones, tus procesos.

Un artículo es un único documento en Markdown. Lo escribes en Markdown plano, lo previsualizas mientras avanzas y lo publicas cuando está listo.

Escribir un artículo

Abre la Base de conocimiento y elige Nuevo artículo. El formulario es breve:

  • Título — el nombre del artículo. El slug de la URL se deriva del título automáticamente (una forma corta en minúsculas-con-guiones); no lo escribes tú.
  • Categoría — la carpeta principal del artículo. Cada artículo vive en exactamente una carpeta. Si aún no creaste ninguna carpeta, usa el botón + para crear una sin salir del formulario. Consulta Carpetas y acceso.
  • Extracto (opcional) — un resumen de una línea que se muestra en los listados.
  • Contenido — el cuerpo, en Markdown.

El editor es un editor de Markdown plano con vista previa en vivo: por diseño no hay un modo de texto enriquecido/WYSIWYG. Los bloques de código se resaltan con sintaxis en la página publicada, cada uno con un botón de copia, y un bloque ```mermaid se renderiza como un diagrama. Tú escribes Markdown en bruto; el formato aparece cuando se ve el artículo.

Mientras escribes, dos ayudas ofrecen autocompletado:

  • Escribir [[ inicia un enlace wiki a otro artículo: consulta Enlaces y descubrimiento.
  • También se admiten referencias a secretos del Gestor de secretos de forma inline; solo ves y eliges un identificador (handle), nunca un valor secreto.

Ayuda de formato (el botón ?)

Un botón ? en la barra de herramientas del editor abre una breve chuleta de formato para que nunca escribas “a ciegas”. Cubre el Markdown plano (encabezados, negrita/cursiva, código, listas) y — lo más útil — los dos tokens reservados de lazyit, cada uno con un ejemplo copiable:

  • Enlazar otro artículo[[slug-del-articulo]], o [[slug-del-articulo|Texto a mostrar]] para un texto de enlace personalizado. Un enlace a un artículo que aún no existe queda como referencia futura.
  • Referenciar un secreto{{ lazyit_secret.handle }}, que se renderiza como un chip enmascarado que solo un miembro del vault puede revelar: consulta Referencias a secretos.
  • Enlace externo — un enlace Markdown estándar [texto](https://…) a cualquier sitio fuera de la Base de conocimiento.

Copia un ejemplo, pégalo en el cuerpo y la vista previa en vivo muestra exactamente cómo se resuelve el token. El mismo ? y la vista previa están disponibles tanto en Nuevo artículo como en Editar.

Tu trabajo está protegido

El editor evita perder el trabajo en curso:

  • Autoguardado local — mientras escribes, tu borrador se guarda en este navegador cada pocos segundos. Es una red de seguridad privada en tu propio equipo, no un guardado en el servidor: el artículo solo cambia cuando pulsas Crear borrador / Guardar cambios. Si la pestaña falla o se cierra por accidente, no se pierde nada.
  • Restaurar al volver — vuelve a abrir Nuevo artículo o Editar y, si hay un borrador local sin guardar, un aviso ofrece Restaurarlo (o Descartarlo). Un artículo guardado nunca se sobrescribe sin tu permiso.
  • Aviso al salir — cerrar la pestaña, recargar o pulsar Cancelar con cambios sin guardar te pide confirmación antes de descartarlos. Un guardado correcto borra el borrador local.

El borrador local vive solo en el navegador donde lo escribiste; no se comparte con tu equipo ni se sincroniza entre dispositivos.

Borradores y publicación

Todo artículo nuevo nace como Borrador. Un borrador es privado de su autor: nadie más puede verlo, y un compañero que adivine su dirección obtiene una página de “artículo no encontrado”, no un error de permisos, de modo que ni siquiera se revela que el borrador existe.

Publica desde el propio artículo:

  • Publicar — pasa el artículo a Publicado y lo hace visible para el equipo (sujeto a las reglas de acceso de su carpeta). La primera publicación deja una fecha de publicación que nunca se borra.
  • Despublicar — devuelve un artículo publicado a Borrador, ocultándolo de nuevo para todos excepto su autor.

Una etiqueta Borrador marca los artículos no publicados en su página. Editar el cuerpo nunca cambia el estado de publicado/borrador: publicar y despublicar son acciones explícitas aparte.

Añadir imágenes

Puedes poner capturas y diagramas directamente en un artículo. La forma más rápida es pegar: copia una imagen al portapapeles y pégala en el panel de origen del editor — lazyit la sube e inserta una referencia de imagen en el cursor. También puedes arrastrar y soltar un archivo de imagen sobre el editor, o usar el botón Insertar imagen de la barra del editor para elegir una.

  • Los tipos admitidos son PNG, JPEG, GIF y WebP, hasta 10 MB cada uno. Otros formatos — incluido SVG — se rechazan; exporta los diagramas a PNG.
  • Las imágenes pertenecen al artículo, así que guarda primero el borrador. En un artículo nuevo que nunca se ha guardado todavía no hay dónde adjuntar una imagen, así que al pegar verás un aviso de “guarda primero el borrador”.
  • Mientras la imagen se sube verás un marcador ![subiendo …]() en el panel de origen; se reemplaza por la referencia real automáticamente al terminar la subida.
  • Las imágenes se muestran en el artículo publicado y en la vista previa, y se sirven solo a quienes ya pueden leer el artículo — una imagen nunca queda expuesta en una URL pública.
  • Solo se almacenan los archivos que pegas, sueltas o subes. Un enlace escrito a mano a una imagen de la web no se muestra (no se cargan imágenes externas); conserva las capturas como adjuntos.

Editar y eliminar

  • Editar abre el mismo formulario sobre el artículo existente. Guardar actualiza el cuerpo; no cambia si el artículo está publicado. Cada edición que cambia el título, el cuerpo o el extracto se registra en el historial del artículo: consulta Versionado.
  • Eliminar quita el artículo de la Base de conocimiento. Es una eliminación lógica: la fila se conserva, no se borra, de modo que puede restaurarse desde la base de datos si hace falta. Su slug también queda libre para que un artículo nuevo reutilice el nombre.

Quién puede hacer qué

La redacción está gobernada por los permisos de la Base de conocimiento, y la API exige además la autoría:

  • Leer la Base de conocimiento requiere el permiso de lectura de artículos, que todos los roles tienen por defecto.
  • Crear, importar, editar, publicar, despublicar y vincular requieren el permiso de escritura de artículos. Por defecto, un redactor normal solo puede editar, publicar o eliminar sus propios artículos — un titular del permiso de escritura que no sea el autor recibe un error de permisos en el artículo de otra persona.
  • Editar cualquier artículo. Dos tipos de usuario quedan exentos de la regla de solo-autor para que un runbook nunca quede bloqueado por un autor no disponible: los administradores (que siempre pueden editar, publicar, eliminar y restaurar cualquier artículo) y los titulares de la capacidad «Editar cualquier artículo» (article:manage). Es un permiso que un administrador puede otorgar a un compañero de confianza. Solo omite la autoría: la persona sigue necesitando el permiso de escritura para editar (o el de eliminación para eliminar), y un titular que no sea administrador tampoco puede tocar un artículo en una carpeta que no puede ver. La atribución nunca se pierde: el autor original permanece registrado y cada edición queda marcada con quién la hizo realmente en el historial de versiones del artículo.
  • Los administradores siempre ven todos los artículos, incluidos los borradores, sin importar las restricciones de carpeta.

Consulta Roles y permisos para el conjunto completo de capacidades.