Merge pull request #415 from SalesforceLabs/VinceFINET-doc-patch

Vince finet doc patch

README.md

@@ -30,13 +30,20 @@
 - [AppExchange](https://sfdc.co/OrgCheck-InstallToday-AppExchange)
 - [Installation Guide](https://SalesforceLabs.github.io/OrgCheck/installation/)
 
+
 ## Have valuable feedback?
 
 You can log any issues and new ideas in our [tracker](https://github.com/SalesforceLabs/OrgCheck/issues).
 
+
 ## Development Setup
 
-To set up a development environment and deploy Org Check as your own unlocked package, follow the steps outlined in the [Development Setup Guide](docs/development.md).
+To set up a development environment and deploy Org Check as your own unlocked package, follow 
+the steps outlined in the [Development Setup Guide](docs/development.md).
+
+Once done when you want to send a Pull Request just do so from Github and we will review it.
+Please note that you will need to sign the Salesforce CLA to do this.
+
 
 ## Useful references
 - [Article on  Salesforce's Ben: "Free technical debt analysis"](https://www.salesforceben.com/salesforce-org-check-free-technical-debt-analysis)

docs/_config.yml

@@ -25,8 +25,5 @@ page_preview_url: /preview
 page_installation_label: Install
 page_installation_url: /installation
 
-page_vision_label: Vision
-page_vision_url: /vision
-
-page_legal_label: Legal Terms
-page_legal_url: /legal
+page_dev_label: Development
+page_dev_url: /development

docs/development.md

@@ -1,22 +1,33 @@
+---
+layout: default
+title: How to setup your own environment to modify the application and propose a PR to the project?
+permalink: /development/
+---
+
+
+
+
 # Development Setup Guide
 
 This guide will walk you through setting up a developer environment allowing you to deploy Org Check as your own unlocked package.
 
+This page is also a good start if you want to participate in the project and propose your own PR o the team!
+
+
 ## Prerequisites
 
 Before you begin, ensure you have the following:
 
 - A development setup with two connected Salesforce orgs
 - Salesforce CLI installed
 
+
 ## Step 1: Clone the Org Check Project
 
 First, clone the Org Check project repository from GitHub:
 
 ```bash
 git clone https://github.com/SalesforceLabs/OrgCheck.git
-```
-```bash
 cd OrgCheck
 ```
 
@@ -85,7 +96,7 @@ Replace `<namespace>` with your actual namespace.
 Create the package using the Salesforce CLI:
 
 ```bash
-sfdx force:package:create --name <namespace> --packagetype Unlocked --path <namespace> -v <devhubalias>
+sf package create --name <namespace> --package-type Unlocked --path <namespace> --target-dev-hub <devhubalias>
 ```
 
 Note the generated **Package Id**.
@@ -95,7 +106,7 @@ Note the generated **Package Id**.
 Create a package version with the generated **Package Id**:
 
 ```bash
-sfdx force:package:version:create -p 0HoDn0000010wBuKAI -x -w 10 -v <devhubalias>
+sf package version create --package <namespace> --installation-key-bypass --wait 10 --target-dev-hub <devhubalias>
 ```
 
 Note the **Subscriber Package Version Id** from the output.
@@ -105,15 +116,21 @@ Note the **Subscriber Package Version Id** from the output.
 If you want to use a scratch org, create it using:
 
 ```bash
-sf force:org:create --definitionfile orgs/dev.json --setalias <scratchorgalias> --targetdevhubusername <devhubalias> --wait 10
+sf org create scratch --definition-file orgs/dev.json --alias <scratchorgalias> --target-dev-hub <devhubalias> --wait 10
 ```
 
 ## Step 9: Deploy the Package
 
-Deploy the package to your org using the **Subscriber Package Version Id**:
+Deploy the package to your org using the **Subscriber Package Version Id**.
+
+```bash
+sf package install --package 04tDn0000011NpHIAU -u <scratchorgalias> -w 10
+```
+
+Alternatively, you can use the corresponding **alias** of the version id, which has been generated for you (on step 7) in the sfdx-project.json under the section **packageAliases**.
 
 ```bash
-sfdx force:package:install -p 04tDn0000011NpHIAU -u <scratchorgalias> -w 10
+sf package install --package <namespace>@1.2.3.4 -u <scratchorgalias> -w 10
 ```
 
 ## Debugging

docs/index.md

@@ -11,6 +11,7 @@ their Salesforce org to monitor and help **continuously reduce their technical d
 
 ![Home Page tab screenshot](./images/screenshots/OrgCheck-Screenshot-Home.png)
 
+
 ## Why would you need this application in your org?
 
 Make sure your Salesforce organisation is under control in terms of **technical debt reduction**.
@@ -25,6 +26,7 @@ You will need org Check to verify some things in your organisation like:
 - Better Automations
 - etc.
 
+
 ## My Vision of the application
 
 This application is **easy to install and easy to use**.
@@ -37,6 +39,7 @@ Please use [this deck](http://sfdc.co/OrgCheck-Presentation) with your colleague
 
 Keep in mind that Org Check is not a Salesforce product. It has not been officially tested or documented by Salesforce. Also Salesforce support is not available for Org Check. Support is based on open source participation and requests are managed (as we can) via GitHub at https://github.com/SalesforceLabs/OrgCheck/issues.
 
+
 ## How do I install this application?
 
 You install this application directly in the org you want to analyse from the AppExchange.
@@ -47,11 +50,33 @@ Then, you navigate through the tabs in the app to discover some bad practices in
 
 Any issues installing the application? Please, [go to this dedicated page](installation) about installation, including some frequently asked questions.
 
-## How to get help and support?
 
+## How to get help and support?
 - Source code is available to anyone at: https://www.sfdc.co/OrgCheck-Repository
 - Issues or ideas are welcome and can be logged by anyone at: https://www.sfdc.co/OrgCheck-Backlog
 - Join our public Slack workspace at: https://sfdc.co/OrgCheck-Community
 
 
+## Useful references
+- [Article on  Salesforce's Ben: "Free technical debt analysis"](https://www.salesforceben.com/salesforce-org-check-free-technical-debt-analysis)
+- [Article on Pablo Gonzalez blog: "10 Salesforce Open-source Projects for DevOps Engineers"](https://www.pablogonzalez.io/top-10-salesforce-open-source-projects-for-devops/#4-orgcheck)
+- [Youtube Video: "Reduce Technical Debt with Org Check"](https://www.youtube.com/watch?v=gjv6q-AR1m0)
+- [Article on Medium: "How to contin uously monitor, balance, challenge, and reduce Technical Debt in a Salesforce org?"](https://medium.com/@vfinet/how-to-continuously-monitor-balance-challenge-and-reduce-technical-debt-in-a-salesforce-org-8809cef4ce4a)
+- [Article on Medium:  "Five concrete actions to reduce technical debt related to Apex Classes"](https://medium.com/@vfinet/five-concret-actions-to-reduce-technical-debt-related-to-apex-classes-reduce-technical-debt-f71a31e4b30c)
+- [Youtube Video: "Org Check Review by Ike Wagh"](https://www.youtube.com/watch?v=IG4zzqVsO_8)
+- [Salesforce Labs Live! "How to Reduce Technical Debt from your Salesforce Environment (Ep.1)"](https://www.youtube.com/watch?v=ZCJ_NH-29I0)
+- [Albanian Dreamin21: "Org Check presentation" by Sara Sali and Vincent Finet](https://dreamin21.sfalbania.al/schedule/schedule-fullwidth-filterable/)
+- [Article on Unofficial SF: "Analyze your org with Org Check"](https://unofficialsf.com/from-vincent-finet-analyze-your-org-with-orgcheck/)
+- [Article on Salesforce's Ben: "Free ways to monitor your Salesforce org"](https://www.salesforceben.com/free-ways-to-monitor-your-salesforce-org/)
+
+
+## I am a developer, how do I contribute?
+
+To set up a development environment and deploy Org Check as your own unlocked package, follow the steps outlined in the [Development Setup Guide](development).
+
+Once done when you want to send a Pull Request just do so from Github and we will review it.
+Please note that you will need to sign the Salesforce CLA to do this.
+
+
+