Skip to content

Commit 3a9a7ed

Browse files
Minor documentation changes #180
1 parent e2bc90c commit 3a9a7ed

File tree

5 files changed

+14
-13
lines changed

5 files changed

+14
-13
lines changed

docs/anexos.pdf

177 Bytes
Binary file not shown.

docs/bibliografiaAnexos.bib

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -211,15 +211,15 @@ @ARTICLE{IEEE1220722020
211211

212212
@misc{ingenieriasoftwareytiemporeal_2020, title={IEEE830-ESP - ctr.unican.es}, url={https://ctr.unican.es/asignaturas/is1/IEEE830_esp.pdf}, journal={ISTR - Ingeniería Software y Tiempo Real}, author={Ingeniería Software y Tiempo Real, ISTR}, year={2020}}
213213
214-
@misc{pythonGetIt, title={Python Download}, url={https://www.python.org/getit/}}
214+
@misc{pythonGetIt, title={Python Download}, url={https://www.python.org/getit/}, note={https://www.python.org/getit/}}
215215

216-
@misc{gitkraken, title={GitKraken}, url={https://www.gitkraken.com/}}
216+
@misc{gitkraken, title={GitKraken}, url={https://www.gitkraken.com/}, note={https://www.gitkraken.com/}}
217217

218-
@misc{VSCode, title={Visual Studio Code}, url= {https://code.visualstudio.com/}}
218+
@misc{VSCode, title={Visual Studio Code}, url= {https://code.visualstudio.com/}, note={https://code.visualstudio.com/}}
219219

220-
@misc{PyCharm, title={PyCharm}, url= {https://www.jetbrains.com/pycharm/}}
220+
@misc{PyCharm, title={PyCharm}, url= {https://www.jetbrains.com/pycharm/}, note={https://www.jetbrains.com/pycharm/}}
221221

222-
@misc{VSCode-Remote-SSH, title={Remote SSH}, url={https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh}}
222+
@misc{VSCode-Remote-SSH, title={Remote SSH}, url={https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh}, note={https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh}}
223223

224224
@misc{Remote-Development-Tricks-Tips, title={Remote Development Tips and Tricks}, url={https://code.visualstudio.com/docs/remote/troubleshooting#_installing-a-supported-ssh-client}, year={2022}, author={Microsoft}}
225225

@@ -234,6 +234,6 @@ @article{leyva2015three
234234
publisher={Elsevier}
235235
}
236236

237-
@misc{Travis-CI-LOG-UBUMLaaS, title={Travis-CI UBUMLaaS}, url={https://app.travis-ci.com/github/dpr1005/UBUMLaaS}}
237+
@misc{Travis-CI-LOG-UBUMLaaS, title={Travis-CI UBUMLaaS}, url={https://app.travis-ci.com/github/dpr1005/UBUMLaaS}, note={https://app.travis-ci.com/github/dpr1005/UBUMLaaS}}
238238

239-
@misc{PyPI, title={Python Package Index}, url={https://pypi.org/}}
239+
@misc{PyPI, title={Python Package Index}, url={https://pypi.org/}, note={https://pypi.org/}}

docs/tex/A_Plan_proyecto.tex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -622,6 +622,7 @@ \subsubsection{\textit{Sprint} 16: Matt 16}
622622
En este \textit{sprint} se ha trabajado principalmente en la memoria y en retoques de código, es por ello que se ha dado una cifra superior de puntos de historia de la media, y con lo visto en el \textit{sprint} anterior, estas tareas están comenzando a llevar más tiempo de que inicialmente se piensa. Se han invertido aproximadamente 37 horas. Los tiempos de trabajo empiezan a ser correctos de forma reiterada con lo planificado.
623623

624624
\item \textbf{\textit{Sprint review meeting}}
625+
625626
Con la experimentación a tres sextos realizada, todavía no se ha encontrado un nexo común que nos permita crear hipótesis, por lo que se aprovecharán las vacaciones de Semana Santa para dejar más experimentos en ejecución y rehacer las \textit{scripts} de análisis de resultados.
626627

627628
UBUMLaaS parece que está correcto en todas sus funcionalidades, por lo que ya se podría afirmar que la parte <<grande>> de modificación está terminada.

docs/tex/B_Requisitos.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ \section{Objetivos generales}\label{objetivos-generales}
3737
Las interfaces a diseñar se requieren que sean intuitivas, fáciles de entender y utilizar. Deberán de ser transparentes al usuario, impidiendo que este conozca la lógica de diseño de la aplicación, así como los posibles fallos internos que se puedan producir por acciones del sistema, del usuario, o de terceros.
3838

3939

40-
\section{Usuarios del \textit{software}}\label{usuarios-participantes}
40+
\section{Usuarios del \textit{software}}\label{usuarios-participantes-software}
4141
Cualquier persona podrá hacer uso de la aplicación UBUMLaaS, siendo únicamente necesarios una serie de datos básicos para su registro dentro de ella.
4242

4343
Dentro de la aplicación se encuentra el usuario base y una generalización del mismo en forma de administrador.

docs/tex/D_Manual_programador.tex

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ \subsection{Estructura de directorios}
4545
\end{itemize}
4646

4747
\subsection{Manual del programador}
48-
En esta subsección se describen todos aquellos recursos seguidos por el equipo de desarrollo para, valga la redundancia, desarrollar el proyecto. De tal forma que un futuro desarrollador/mantenedor del proyecto no tenga inconvenientes a la hora de retomar el proyecto y conocerlo.
48+
En esta subsección se describen todos aquellos recursos utilizados por el equipo de desarrollo para, valga la redundancia, desarrollar el proyecto. De tal forma que un futuro desarrollador/mantenedor del proyecto no tenga inconvenientes a la hora de retomar el proyecto y conocerlo.
4949

5050
\subsubsection{Entorno de desarrollo}
5151
Para poder continuar con el desarrollo del proyecto, se requiere tener instalado el siguiente \textit{software} en el equipo:
@@ -167,7 +167,7 @@ \subsubsection{Importar el proyecto en Visual Studio Code}
167167
\begin{enumerate}
168168
\item Apertura de \texttt{Visual Studio Code}.
169169
\item Hacer \textit{click} en Abrir.
170-
\item Seleccionar el directorio raíz dónde lo hayamos alojado.
170+
\item Seleccionar el directorio raíz donde lo hayamos alojado.
171171
\end{enumerate}
172172
\item Importar el proyecto en una máquina y editarlo desde otra.
173173
\begin{enumerate}
@@ -188,7 +188,7 @@ \subsubsection{Importar el proyecto en Visual Studio Code}
188188
\end{itemize}
189189

190190
\subsubsection{Crear entorno virtual de trabajo}
191-
Para poder trabajar con este proyecto (independientemente de si es para desarrollo o producción) hacen falta una serie de bibliotecas concretas de Python, las cuales, como es lógico, deben estar en la máquina en la que se va a correr; dicho con otras palabras, en la que está el código. El proyecto está preparado para crear un entorno de \texttt{Conda} propio, de forma que no interfiera con otros proyectos y sea más sencillo de mantener y actualizar.
191+
Para poder trabajar con este proyecto (independientemente de si es para desarrollo o producción) hacen falta una serie de bibliotecas concretas de Python, las cuales, como es lógico, deben estar en la máquina en la que se va a ejecutar; dicho con otras palabras, en la que está el código. El proyecto está preparado para crear un entorno de \texttt{Conda} propio, de forma que no interfiera con otros proyectos y sea más sencillo de mantener y actualizar.
192192

193193
Se recomienda que los binarios de anaconda o miniconda estén configurados en el \texttt{path} del sistema para poder utilizar el comando \texttt{conda} desde la línea de comandos.
194194

@@ -233,7 +233,7 @@ \subsubsection{Instalación en Linux}
233233
\end{enumerate}
234234

235235
\subsubsection{Uso del proyecto}
236-
Lo primero de todo para poder tener el producto trabajando, es desplegarlo, para ello es requisito haber completado todos los pasos previos de esta sección. Activar el entorno virtual de \texttt{Conda}, correr el lanzador, y ya está en ejecución.
236+
Lo primero de todo para poder tener el producto trabajando, es desplegarlo, para ello es requisito haber completado todos los pasos previos de esta sección. Activar el entorno virtual de \texttt{Conda}, ejecutar el lanzador, y ya está en ejecución.
237237
\begin{lstlisting}[language=bash]
238238
conda activate UBUMLaaS
239239
./run.sh
@@ -250,7 +250,7 @@ \subsection{Integración Continua}
250250
\subsubsection{Codacy}
251251
Herramienta la cual proporciona soporte a análisis automático del código fuente e identifica los problemas a medida que avanza. Su versatilidad permite desarrollar \textit{software} de manera eficiente, reduciendo el número de \textit{bugs} que se <<dejan para resolver>>.
252252

253-
A través del análisis estático de código estático, notifica problemas de seguridad, cobertura del código, así como la duplicación y la complejidad de cada fichero en cada \textit{commit} y \textit{pull request}.
253+
A través del análisis de código estático, notifica problemas de seguridad, cobertura del código, así como la duplicación y la complejidad de cada fichero en cada \textit{commit} y \textit{pull request}.
254254

255255
\imagenRuta{../img/anexos/manual-programador/Codacy-UBUMLaaS}{Codacy.}{Codacy-UBUMLaaS}
256256

0 commit comments

Comments
 (0)