From e0c5e51700d68814571debe6c65776b62db4d1a0 Mon Sep 17 00:00:00 2001 From: zanninso Date: Fri, 29 Sep 2023 03:24:56 +0100 Subject: [PATCH] docs: add '+' to the audit bonus questions --- .../java/projects/angul-it/audit/README.md | 10 ++--- .../java/projects/mr-jenk/audit/README.md | 38 +++++++++---------- subjects/java/projects/nexus/audit/README.md | 6 +-- 3 files changed, 26 insertions(+), 28 deletions(-) diff --git a/subjects/java/projects/angul-it/audit/README.md b/subjects/java/projects/angul-it/audit/README.md index 623f3104c7..f8b3643426 100644 --- a/subjects/java/projects/angul-it/audit/README.md +++ b/subjects/java/projects/angul-it/audit/README.md @@ -36,18 +36,18 @@ ##### Multiple Challenge Sets -###### Are there multiple sets of challenges that are randomly assigned to each user session? +###### +Are there multiple sets of challenges that are randomly assigned to each user session? ##### Transitions and Responsiveness -###### Are there smooth animations between challenges? +###### +Are there smooth animations between challenges? -###### Is the application responsive across different devices and screen sizes? +###### +Is the application responsive across different devices and screen sizes? ##### Testing (optional) -###### Are there unit tests for the components? +###### +Are there unit tests for the components? -###### Do the tests cover all the important aspects of the components? +###### +Do the tests cover all the important aspects of the components? Remember to use this audit as a guideline to assess the student's work. The student doesn't have to implement all the bonus tasks to pass the project. The main focus should be on understanding and correctly using Angular concepts to build the application. diff --git a/subjects/java/projects/mr-jenk/audit/README.md b/subjects/java/projects/mr-jenk/audit/README.md index 4031add692..d4289d187a 100644 --- a/subjects/java/projects/mr-jenk/audit/README.md +++ b/subjects/java/projects/mr-jenk/audit/README.md @@ -1,57 +1,55 @@ -## CI/CD with Jenkins Audit +#### Functional -### Functional - -#### Download the project and trigger a Jenkins build. Observe if the pipeline runs as expected. +##### Download the project and trigger a Jenkins build. Observe if the pipeline runs as expected. ###### Does the pipeline initiate and run successfully from start to finish? -#### Trigger some intentional build errors and observe Jenkins' response. +##### Trigger some intentional build errors and observe Jenkins' response. ###### Does Jenkins respond appropriately to build errors? -#### Examine the automated testing step. +##### Examine the automated testing step. ###### Are tests run automatically during the pipeline execution? Does the pipeline halt on test failure? -#### Make a minor change in the source code, commit, and push. Observe if the pipeline is triggered automatically. +##### Make a minor change in the source code, commit, and push. Observe if the pipeline is triggered automatically. ###### Does a new commit and push automatically trigger the Jenkins pipeline? -#### Check the deployment process. +##### Check the deployment process. ###### Is the application deployed automatically after a successful build? Is there a rollback strategy in place? -### Security +#### Security -#### Examine the permissions on the Jenkins dashboard. +##### Examine the permissions on the Jenkins dashboard. ###### Are permissions set appropriately to prevent unauthorized access or changes? -#### Review how sensitive data (like API keys, passwords) is managed in Jenkins. +##### Review how sensitive data (like API keys, passwords) is managed in Jenkins. ###### Is sensitive data secured using Jenkins secrets or environment variables? -### Code Quality and Standards +#### Code Quality and Standards -#### Examine the Jenkinsfile or the build configuration. +##### Examine the Jenkinsfile or the build configuration. ###### Is the code/script well-organized and understandable? Are there any best practices being ignored? -#### Look into the test report formats and outputs. +##### Look into the test report formats and outputs. ###### Are test reports clear, comprehensive, and stored for future reference? -#### Check for notifications setup. +##### Check for notifications setup. ###### Are notifications triggered on build and deployment events? Are they informative? -### Bonus +#### Bonus -#### Examine if parameterized builds are implemented. +##### Examine if parameterized builds are implemented. -###### Are there options for customizing the build run with different parameters? +###### +Are there options for customizing the build run with different parameters? -#### Examine the distributed builds (if implemented). +##### Examine the distributed builds (if implemented). -###### Are multiple agents utilized effectively for distributed builds? \ No newline at end of file +###### +Are multiple agents utilized effectively for distributed builds? \ No newline at end of file diff --git a/subjects/java/projects/nexus/audit/README.md b/subjects/java/projects/nexus/audit/README.md index b9f8634ed9..51dfe81dfb 100644 --- a/subjects/java/projects/nexus/audit/README.md +++ b/subjects/java/projects/nexus/audit/README.md @@ -48,10 +48,10 @@ ##### Security Exploration -###### Have Nexus security features like user authentication and role-based access control been explored? +###### +Have Nexus security features like user authentication and role-based access control been explored? -###### Are repository-level permissions effectively configured? +###### +Are repository-level permissions effectively configured? ##### Configuration -###### Are security settings configured to restrict access to specific artifacts or repositories in Nexus? +###### +Are security settings configured to restrict access to specific artifacts or repositories in Nexus?