This website is built using Docusaurus 2, a modern static website generator.
Este proyecto es una web estática construida con el framework Docusaurus 2. Para más detalles de su funcionamiento consultar la documentación oficial: https://docusaurus.io/docs.
Para obtener el código fuente, ejecutar el siguiente comando en el directorio donde se desee descargar el proyecto:
git clone https://github.com/mauricioCerizza/utn-prog-ii
Para correr el proyecto localmente ejecutar el siguiente comando desde el directorio raíz:
npm run docusaurus startPara poder realizar el despliegue se deberá configurar la siguiente variable de entorno en el sistema operativo:
GIT_USER=<Tu usuario en GitHub>El valor de la variable debe ser el usuario de github con el que se tenga privilegios para trabajar sobre el repositorio.
Por último, para realizar el despliegue se deberá ejecutar desde el directorio raíz el siguiente comando:
npm run docusaurus deploySe deberá mantener el repositorio con el código fuente actualizado.
Siempre pushear a la rama master, salvo que se esté trabajando por algún motivo en otra rama que finalmente igual deberá ser mergeada a master.
Para generar los apuntes en PDF se deberá ejecutar el siguiente comando desde el directorio raíz (después de haber deployado la última versión):
npx mr-pdf --initialDocURLs="https://mauriciocerizza.github.io/utn-prog-ii/docs/clases/programa" --contentSelector="article" --paginationSelector=".pagination-nav__item--next > a" --excludeSelectors=".margin-vert--xl a" --coverImage="https://upload.wikimedia.org/wikipedia/commons/6/67/UTN_logo.jpg" --coverTitle="Programación II" --pdfFormat="A4" --outputPDFFilename="static/clases/Programacion-II.pdf"-> Directorio raíz
-> docs (páginas con markdown)
-> clases (temario con apuntes y ejercicios)
-> ##-tema (carpeta de un tema particular)
-> Apuntes (páginas .md de apuntes teóricos y cuestionario)
-> Ejercicios (páginas .md de ejercicios prácticos)
-> introduccion (introducción a la materia)
-> static (archivos estáticos)
-> base (estáticos de uso general.)
-> clases (estáticos para las páginas de clases, apuntes y ejercicios. Refleja la misma estructura.)
-> introducción (estáticos para las páginas de introducción a la materia)
-> src (código fuente base de la web)
Se deberá trabajar dentro de la carpeta clases la cual cuenta con varios directorios hijos, cada uno representando un tema de la materia.
Cada una de estas sub-carpetas se divide en 3 partes:
Aquí se encontrarán los enlaces a cada una de las páginas de apuntes y a cada ejercicio.
Comenzará con un resumen del tema, seguido de los enlaces a los apuntes y cuestionario, ejercicios prácticos y, por último, también contendrá las referencias a la bibliografía del tema.
En la carpeta Apuntes iremos generando un archivo .md por cada página de apuntes.
Cada uno de estos archivos empezará con un número de dos dígitos que deberá incrementarse de acuerdo al orden que se establezca para cada página.
Todo conjunto de apuntes finaliza con el cuestionario teórico del tema en cuestión.
A medida que se agregan nuevas páginas, se deberá ir actualizando el índice para el tema en cuestión.
Cada ejercicio práctico deberá estar colocado dentro de la carpeta Ejercicios de su respectivo tema.
Se deberá generar un archivo .md por cada ejercicio, el cual deberá ser nombrado siguiendo la siguiente categorización:
| Categorías | Prefijo | Descripción |
|---|---|---|
| Introductorio | I## | Se enfocan en el contenido de la sección, no dependen de ejercicios previos y vienen acompañados de un diagrama de clase o descripción paso a paso de lo que hay que hacer. |
| Análisis funcional | A## | Plantean un requerimiento funcional y no especifican en profundidad cómo resolverlo. Sirven para ejercitar la creatividad junto con las capacidades de análisis y diseño. |
| Corrección de errores | E## | Son ejercicios de detección y corrección de errores, una tarea habitual en el ambiente profesional. |
| Consolidación | C## | Sirven para ejercitar el tema de la sección en conjunto con los aprendidos en clases anteriores. Pueden tener dependencias con ejercicios previos. |
| Investigación | R## | Para resolverlos se requerirá investigar contenido no abarcado por el temario. Son desafiantes y refuerzan las habilidades de búsqueda de soluciones en internet, aprendizaje auto-didacta e interpretación de documentación. |
Al final de cada página de ejercicio podremos enlazar la resolución en código y/o video.
A medida que se agregan nuevos ejercicios, se deberá ir actualizando el índice para el tema en cuestión.
Los archivos estáticos se deberán almacenar en la carpeta static la cual refleja una estructura similar a la carpeta docs.
Cuando se necesite almacenar una imagen, diagrama, documento, o cualquier otro archivo estático, se deberá colocar en la carpeta correspondiente a donde esté ubicada la página donde se mostrará.
Por ejemplo, si se trata de un diagrama que se mostrará en los ejercicios de colecciones, va en el directorio static/clases/06-colecciones/Ejercicios/. Si se tratara de una imagen para un apunte: static/clases/06-colecciones/Apuntes/.
Para insertar una imagen con markdown se utiliza la siguiente sintaxis:
Para insertar fragmentos de código en la documentación se deberá utilizar la siguiente sintaxis:
```csharp
public class Prueba
{
string s = "C# syntax highlighting"
Console.WriteLine(s)
}
```🔥 NO utilizar imagenes para mostrar código, es dificil de mantener y no permite copiar y pegar.
Para hacer un comentario en markdown se deberá usar la siguiente sintaxis:
[//]: # "Comentario"Para marcar una tarea pendiente, se deberá dejar un comentario con el prefijo TODO:
[//]: # "TODO Descripción de tarea pendiente"La bibliografía y material de referencia de cada sección deberá citarse en la página del índice siguiendo el formato detallado a continuación.
Apellido e iniciales de autor/es. Título del libro en cursiva (Edición, Volumen, Páginas). Editorial.
Price, M. J. (2020). C#9 and .NET 5 - Modern Cross-Platform Development. (5th ed., pp. 41-202). Packt Publishing.
Título del artículo o página en cursiva. Nombre de la web donde se encuentra el artículo. Enlace.
.NET Architectural Components. Microsoft Docs. https://docs.microsoft.com/en-us/dotnet/standard/components.
También se puede agregar a los apuntes artículos o información externa en forma de enlace.
Para saber más, consulta la [documentación](https://dotnet.microsoft.com/).