From ca306b26ab23505629bea8bea256b3e54f85a951 Mon Sep 17 00:00:00 2001 From: Nika Zhenya Date: Thu, 2 Dec 2021 00:18:15 -0600 Subject: [PATCH 1/3] =?UTF-8?q?Traducci=C3=B3n=20al=20espa=C3=B1ol=20de=20?= =?UTF-8?q?lo=20que=20va=20+=20correcci=C3=B3n=20de=20erratitas=20en=20ing?= =?UTF-8?q?l=C3=A9s?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/source/basic_usage.rst | 4 +- docs/es/source/advanced_usage.rst | 12 ++++++ docs/es/source/basic_usage.rst | 62 +++++++++++++++++++++++++++++++ docs/es/source/index.rst | 56 +++++++++++++++++++++------- 4 files changed, 119 insertions(+), 15 deletions(-) create mode 100644 docs/es/source/advanced_usage.rst create mode 100644 docs/es/source/basic_usage.rst diff --git a/docs/en/source/basic_usage.rst b/docs/en/source/basic_usage.rst index 5cb44a9..581dddf 100644 --- a/docs/en/source/basic_usage.rst +++ b/docs/en/source/basic_usage.rst @@ -26,7 +26,7 @@ Tiempo has other advantages: * Fixed some input inconsistencies. * Solved some old issues in Timetrap. * Columns in the output are always aligned. -* CLI interface is easier to discover (ask ``-h`` for any sub-command) +* CLI interface is easier to discover (ask ``-h`` for any sub-command). * End times are printed with +1d to indicate that the activity ended the next day in the 'text' formatter. @@ -51,7 +51,7 @@ If you use Arch Linux, install `tiempo-git` package from the `AUR`_, for example Quickstart ---------- -dolo +TODO .. _Timetrap: https://github.com/samg/timetrap/ .. _hard to install: https://github.com/samg/timetrap/issues/176 diff --git a/docs/es/source/advanced_usage.rst b/docs/es/source/advanced_usage.rst new file mode 100644 index 0000000..6d3f977 --- /dev/null +++ b/docs/es/source/advanced_usage.rst @@ -0,0 +1,12 @@ +Advanced Usage +============== + +Subcommands +----------- + +bla + +Settings +-------- + +bla diff --git a/docs/es/source/basic_usage.rst b/docs/es/source/basic_usage.rst new file mode 100644 index 0000000..83a15f2 --- /dev/null +++ b/docs/es/source/basic_usage.rst @@ -0,0 +1,62 @@ +Introducción +============ + +¿Qué es Tiempo? +--------------- + +Tiempo es una herramienta de línea de comandos para rastrear el tiempo. Te ayuda a grabar +el tiempo empleado en diferentes actividades y de manera opcional te permite organizarlas +en proyectos o `sheets` (hojas). Tiempo es compatible con `Timetrap`_, su predecesor. + + ¿Por qué otro rastreador de tiempo en lugar de mejorar Timetrap? + +* Timetrap es `difícil de instalar`_, difícil de mantenerlo `actualizado`_ (debido a Ruby). + Con Tiempo puedes obtener o compilar un binario, ponerlo donde sea y simplemente funcionará + en la máquina. Estoy embebiendo SQLite. +* Timetrap es lento (no hay modo de sacarle la vuelta, es por Ruby), algunos comandos + tardan hasta un segundo. Tiempo siempre se siente rápido. +* Timetrap necesitaba una refactorización mayor para arreglar un problema con el huso + horario (en un lenguaje en el que no soy experto). Estaba al tanto de este problema + y diseñé Tiempo para guardar marcas de tiempo en UTC así como es posible + trabajar con la base de datos hecha por Timetrap sin estropearla. Y muchas pruebas + se han realizado que respaldan esta afirmación. + +Tiempo tiene otras ventajas: + +* Arreglé algunas inconsistencias en el input. +* Resolví algunas incidencias antiguas de Timetrap. +* Las columnas del output están siempre alineadas. +* La interfaz de línea de comandos es más fácil de descubrir (pregunta ``-h`` para cualquier subcomando). +* Los tiempos de conclusión se imprimen con un +1d para indicar que la actividad acabó al siguiente + día. + +Instalación +----------- + +Si tienes instaladas las herramientas de `Rust`_, solo ejecuta: + +.. code:: bash + + cargo install tiempo + +Si usas Arch Linux, instala el paquete `tiempo-git` desde `AUR`_, por ejemplo: + +.. code:: bash + + git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si + +.. NOTE:: + Requieres tener instalado `Rust`_ y `Cargo`_. Para más información haz `clic aquí`_. + +Inicio rápido +------------- + +TODO + +.. _Timetrap: https://github.com/samg/timetrap/ +.. _difícil de instalar: https://github.com/samg/timetrap/issues/176 +.. _actualizado: https://github.com/samg/timetrap/issues/174 +.. _clic aquí: https://doc.rust-lang.org/cargo/getting-started/installation.html +.. _Rust: https://rust-lang.org +.. _Cargo: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html +.. _AUR: https://aur.archlinux.org/packages/tiempo-git/ diff --git a/docs/es/source/index.rst b/docs/es/source/index.rst index 8c8dd73..e657d44 100644 --- a/docs/es/source/index.rst +++ b/docs/es/source/index.rst @@ -1,20 +1,50 @@ -.. tiempo documentation master file, created by - sphinx-quickstart on Tue Oct 26 20:13:00 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to tiempo's documentation! -================================== +Documentación de Tiempo +======================= .. toctree:: :maxdepth: 2 - :caption: Contents: + :caption: Contenidos: + basic_usage + advanced_usage +Tiempo es una herramienta de línea de comandos para rastrear el tiempo. Te ayuda a grabar +el tiempo empleado en diferentes actividades y de manera opcional te permite organizarlas +en proyectos o `sheets` (hojas). Tiempo es compatible con `Timetrap`_, su predecesor. -Indices and tables -================== +Instalación +----------- -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +Si tienes instaladas las herramientas de `Rust`_, solo ejecuta: + +.. code:: bash + + cargo install tiempo + +Si usas Arch Linux, instala el paquete `tiempo-git` desde `AUR`_, por ejemplo: + +.. code:: bash + + git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si + +.. NOTE:: + Requieres tener instalado `Rust`_ y `Cargo`_. Para más información haz `clic aquí`_. + +Inicio rápido +------------- + +Ve `aquí`_... + +Agradecimientos especiales +-------------------------- + +A `Timetrap`_ por existir y a `samg`_ por hacerlo. Esta herramienta es lo que estaba +buscando y a la que tomé de referencia, manteniendo compatibilidad en lo posible. + +.. _Timetrap: https://github.com/samg/timetrap/ +.. _samg: https://github.com/samg +.. _aquí: basic_usage.html#inicio-rapido +.. _clic aquí: https://doc.rust-lang.org/cargo/getting-started/installation.html +.. _Rust: https://rust-lang.org +.. _Cargo: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html +.. _AUR: https://aur.archlinux.org/packages/tiempo-git/ From 6e82922efac2ded0c54d499cd738db45ae00a3fb Mon Sep 17 00:00:00 2001 From: Nika Zhenya Date: Thu, 2 Dec 2021 20:47:10 -0600 Subject: [PATCH 2/3] =?UTF-8?q?Pipeline=20pa=20publicaci=C3=B3n=20de=20doc?= =?UTF-8?q?u?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitlab-ci.yml | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index fc4434e..cbcb240 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,8 +1,24 @@ -image: "rust:latest" +image: python:3.7-alpine -test:cargo: +test: + stage: test script: - - rustc --version && cargo --version # Print version info for debugging - - rustup component add clippy - - cargo clippy -- -D warnings - - cargo test + - pip install -U sphinx + - mkdir -p public/{es,en} + - sphinx-build -b html ./docs/es/source/ public/es + - sphinx-build -b html ./docs/en/source/ public/en + rules: + - if: $CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH + +pages: + stage: deploy + script: + - pip install -U sphinx + - mkdir -p public/{es,en} + - sphinx-build -b html ./docs/es/source/ public/es + - sphinx-build -b html ./docs/en/source/ public/en + artifacts: + paths: + - public + rules: + - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH From 0c5025adc1aad52d53f1262064a1f2e31c2ecc18 Mon Sep 17 00:00:00 2001 From: Abraham Toriz Date: Fri, 3 Dec 2021 08:43:04 -0600 Subject: [PATCH 3/3] restore test task --- .gitlab-ci.yml | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index cbcb240..b2f2cde 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,6 +1,13 @@ -image: python:3.7-alpine +test:cargo: + image: rust:latest + script: + - rustc --version && cargo --version # Print version info for debugging + - rustup component add clippy + - cargo clippy -- -D warnings + - cargo test -test: +build:docs: + image: python:3.7-alpine stage: test script: - pip install -U sphinx @@ -9,7 +16,7 @@ test: - sphinx-build -b html ./docs/en/source/ public/en rules: - if: $CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH - + pages: stage: deploy script: