From 7e1087f2d74c11e1bbff1839d376900753cf6045 Mon Sep 17 00:00:00 2001 From: Carlos Date: Wed, 25 Oct 2023 19:38:57 -0300 Subject: [PATCH] Adding alternative text in the pictures to the contribution file --- CONTRIBUTING.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ec5379ed..8b8fd08b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -140,7 +140,7 @@ Please be sure to take a careful look at our [Code of Conduct](https://github.co Navigate to the landing page of the repository in your web browser and click on the **_Fork_** button on the repository’s home page. A forked copy of that Git repository will be added to your personal GitHub. -![](images/fork-project-1.png) +![Click the 'fork' button](images/fork-project-1.png) ### Step 2: Clone the Project. @@ -148,41 +148,41 @@ A forked copy of that Git repository will be added to your personal GitHub. A **clone** is a full copy of a repository, including all logging and versions of files. To **_clone_** the Project to your local desktop by clicking on the button as shown below. - ![](images/clone-project-2.png) + ![Click 'Open the GitHub Desktop' from the code dropdown](images/clone-project-2.png) ### Step 3: Open the Project using IntelliJ IDEA **_Open_** the Cloned Project using IntelliJ IDEA by clicking on the button as shown below. -![](images/open-project-3.1.png) +![Click 'Open in JetBrains IntelliJ IDEA' button](images/open-project-3.1.png) **Wait** till the Project Loads. -![](images/wait-3.2.png) +![Loading project](images/wait-3.2.png) ### Step 4: Setup. Open Settings by pressing **_Ctrl+Alt+S_** -![](images/open-settings-4.1.png) +![Click on 'Settings' button or press Cltr + Alt + S](images/open-settings-4.1.png) Follow the path **_IDE settings>Language & Frameworks > Lombok_** and then click on **_Lombok._** -![](images/lombok-setup-4.2.png) +![Click on the 'Lombok' button within the path: Settings > Language & Frameworks.](images/lombok-setup-4.2.png) Make sure that the **_Lombok processing_** is enabled. -![](images/lombok-processing-4.3.png) +![Lombok checkboxes checked ](images/lombok-processing-4.3.png) Select **_Plugins > Marketplace_** and type 'google-java-format' and restart IntelliJ to install the plugin. Open Settings by pressing **_Ctrl+Alt+S_** -![](images/open-settings-4.1.png) +![Click on 'Settings' button or press Cltr + Alt + S](images/open-settings-4.1.png) Select **_google-java-format Settings_** and click enable. -![](images/open-settings-4.4.png) +![The Google-java-format Settings checkbox are checked](images/open-settings-4.4.png) ### Step 5: Project Structure @@ -197,11 +197,11 @@ In the tab `SDKs` make sure that an SDK of version `21` is selected. Open the **_Maven_** Tab -![](images/open-maven-5.1.png) +![Maven tab](images/open-maven-5.1.png) Press the **_Reload_** button as shown below and allow the project to Reload. -![](images/reload-maven-5.2.png) +![Click the 'Reload' button in the Maven tab.](images/reload-maven-5.2.png) Further use the **_OWASP WrongSecrets --> Lifecycle --> install_** step to load all the depedencies @@ -211,44 +211,44 @@ Further use the **_OWASP WrongSecrets --> Lifecycle --> install_** step to load Open the **_WrongSecretsApplication_** by following the path **_main>java>org.owasp.wrongsecrets>WrongSecretApplication_**. -![](images/open-application-6.1.png) +![Click on the 'WrongSecretsApplication' file located at main > java > org.owasp.wrongsecrets > WrongSecretApplication](images/open-application-6.1.png) Press **_Shift+F10_** to run the application, this will open up the **_Run/Debug Configurations Menu._** -![](images/run-application-6.2.png) +![Click the 'Run' button or press Shift + F10](images/run-application-6.2.png) ### Step 8: Setting up Configurations. Select **_Edit configuration templates_** then select **_Application_** section. -![](images/edit-config-7.1.png) +![In the bottom left corner click on 'Edit configuration templates...'](images/edit-config-7.1.png) There under the **_Application_** section click on the button shown below. -![](images/modify-options-7.2.png) +![In the application section, click 'Modify options' to show below](images/modify-options-7.2.png) **_Select_** all the fields that are Selected in the below picture. -![](images/select-options-7.3.png) +![In the Run Options select: 'Enviroment variables' | 'Add VM options' | 'Shorten command line' | 'Specify classes and packages' | 'Open run/debug tool window when started'](images/select-options-7.3.png) **_Fill out_** all the fields as shown below. -![](images/fill-fields-7.4.png) +![Fill out the fields: | Build and run: org.owasp.wrongsecrets.WrongSecretsApplication : -Dserver.port=8080 - Dspring.profiles.active=local,without-vault. | Working directory: /Users/razr/workspace/owasp/wrongsecrets | Environment variables: K8S_ENV=docker| Packages and classes to include in covarege data: org.owasp.wrongsecrets.*| ](images/fill-fields-7.4.pn) Again press **_Shift+F10_** which runs the Application. -![](images/run-application-6.2.png) +![Click the 'Run' button or press Shift + F10](images/run-application-6.2.png) ### There you have it, **_WrongSecrets_** running successfully. Here is a _preview_ on how does it look after successfully running the Application. **Note:** Running the Application doesn't open any kind of **_GUI_**, it only initializes the **_local webserver_** that you can open via a **_browser._** -![](images/final-output-8.png) +![Command line terminal running successfully](images/final-output-8.png) Here is the preview of the **web server**, you can try to find the secrets by means of solving the challenge offered at: [**Challenges**](https://github.com/OWASP/wrongsecrets#basic-docker-exercises) -![](images/screenshot.png) +![Preview Challenge 1](images/screenshot.png) ---