Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add file documentation and project source of log4j2. #22
base: master
Are you sure you want to change the base?
Add file documentation and project source of log4j2. #22
Changes from 1 commit
cab42ba
dce9c7d
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Traducir a español. En general, revisar esta lista. Esto parece un copy & paste de la documentación. Traduce todas las funcionalidades al español, y agrega un muy breve descripción.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Se realizó la traducción y se agrego la descripción correspondiente.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
¿cuál es la idea de la primer viñeta en relación con la segunda? Al leerlas genera la impresión que una no tiene que ver con la otra..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Se mueve esta sección a otro módulo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo:
encontrar -> encuentra
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Falta numeración
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aquí vale la pena documentar las configuraciones que se toman por default, justamente cuando no se encuentran los archivos. Por ejemplo, el nivel de logging es INFO, etc...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Según recuerdo, esta reglas se ejecutan en el orden de esta lista. De ser así, vale la pena mencionarlo en la explicación.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
¿in the classpath? ¿spanglish? evita hacer copy & paste de la documentación. Traducir esta parte. Revisar toda la lista ya que aparece varias veces.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
¿traza? En español no usamos esta palabra.. suena raro. Mejorar la traducción.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Falta numeración...
Los nombres de los archivos también deben ir en comillas simples invertidas:
log4j2.properties
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aquí falta agregar una línea que diga que el siguiente código es un ejemplo. Agregar la siguiente línea:
Ejemplo:
Por otro lado, este ejemplo es un archivo properties. Entonces no debes usar bash debes emplear properties .Esto permite que el editor agregue colorcitos al ejemplo y se pueda leer mejor.
Finalmente, antes de presentar el ejemplo, considero que hace falta una pequeña explicación general que describa al archivo. Por ejemplo, mencionar que este ejemplo contiene las propiedades mínimas o básicas recomendadas, etc..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry. No entendí estos comentarios. No me quedó claro que significa el property
status
Podrías ser más corto y conciso en tu explicación ?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mejorar el comentario.. Debes escribir una descripción breve y clara del significado de cada property.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mejorar comentario.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mejorar comentario y en español.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mejorar comentario.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Creo que sería bueno explicar a nivel general el significado de cada pattern. SI es demasiado podrías solo indicar que se va a revisar más adelante. O si de plano es mucha documentación, entonces poner una liga donde se pueda consultar.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mejorar comentario.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mejorar comentario. Valdría la pena indicar posibles tipos de consolas.. o las distintas opciones que se pueden emplear.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
¿ por qué otra vez un patrón de formato ?
Debido a que este es tu primer ejemplo, creo que debería contener solo lo mínimo o básico. Ya mas adelante puedes explicar cosas mas avanzadas.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mejorar comentario.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
¿explicación en inglés? Evita copy & paste.
¿ qué son esos números que aparecen después de los niveles... 100, 200, etc ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No entendí esta oración. Es una orden ? o cuál es la idea ? Mejora redacción.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Antes de iniciar con la configuración de gradle, creo que vale la pena agregar una sección donde expliques la forma en la que Log4J2 se distribuye. Es decir, ahora log4J2 se distribuye en varios jars. Entonces hay que listarlos y escribir una breve explicación. En especial hacer énfasis que
log4j-api
contiene las clases agnósticas a la implementación y que puedes usar cualquier otra implementación.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
después de las 3 comillas, agrega la palabra groovy
build.gradle tiene esta sintaxis, y así el código se ve mucho mejor.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
usa la forma corta:
compile "org.apache.logging.log4j:log4j-api:$log4jVersion"
Observa el uso de la variable
$log4jVersion
Recomiendo que agregues variables para no hardcodear valores varias veces. Revisa ejemplos en el tutorial de junit.Ahora, para el caso del otro jar, según yo no debe ser
compile
, debería ser soloruntime
. Esto implica que las clases del jarlog4j-core
no deben aparecer en el código fuente. Esto protege al código para que no se usen clases de una implementación en especifico. Es decir, quedaría así:runtime "org.apache.logging.log4j:log4j-core:$log4jVersion"
Revisa si esta propuesta funciona.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remover el símbolo de gato, y revisa la numeración. ¿realmente es el tema 2 ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
¿ a qué te refieres con "Instancias del logger" ? no sería mejor indicar el nombre de la clase de donde salen las instancias ? Procura mejorar redacción. No seas tan técnico. Piensa que es un tutorial Por ejemplo:
La clase LogManager representa el punto de entrada para crear instancias de xxxxx.... algo así.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
¿ a qué te refieres con logging framework??? Mejora la traducción y explicación.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No creo que sea buena idea poner etc... Menciona todos los posibles niveles. No son muchos.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nuevamente, debes agregar la palabra "Ejemplo:" antes de poner tu código. Revisa otros tutoriales para que veas la convención que estoy siguiendo. NO dejes solo el símbolo de gato.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Transforma este ejemplo en una prueba unitaria con JUnit 5. Hay que poner el ejemplo con nuestros propios tuturiales.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Te faltan los gatos:
Fin de módulo.
Revisa el formato de otros tutos.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Supongo que habrá más módulos vdd ? este primer PR solo contiene un Ejemplo básico. Recomiendo renombrar el archivo md a modulo01.md y procura que tu PR tenga un título más adecuado, por ejemplo: tutorial log4j2 - modulo 1.
Hay muchas funcionalidades que vale la pena documentar: expresiones lambda, desempeño, etc,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quedamos en que ibas a eliminar este archivo. ¿ no funciona si lo quitas ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mismo caso, Quedamos en que ibas a eliminar este archivo. ¿ no funciona si lo quitas ?