Skip to content

Commit e44d2eb

Browse files
VinceFINETVinceFINET
committed
Merge branch 'main' into helium
2 parents aa57d9d + 2b3ea7b commit e44d2eb

File tree

11 files changed

+104
-178
lines changed

11 files changed

+104
-178
lines changed

‎docs/_config.yml‎

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,44 @@
1-
title: Org Check
2-
email: [email protected]
1+
remote_theme: pages-themes/[email protected]
2+
plugins:
3+
- jekyll-remote-theme
4+
5+
show_title: false
6+
##title: Org Check
7+
8+
show_imagetitle: true
9+
imagetitle: https://vincefinet.github.io/OrgCheck/assets/pngs/Logo+Mascot-v3.png
10+
311
description: Org Check is an easy-to-install and easy-to-use Salesforce application in order to quickly analyze your org and its technical debt.
12+
13+
show_downloads: false
14+
15+
email: [email protected]
416
twitter_username: VinceFINET
517
github_username: VinceFINET
6-
theme: jekyll-theme-minimal
7-
logo: assets/pngs/Logo+Mascot-v3.png
818

919
page_home_label: Home
1020
page_home_url: /
21+
1122
page_preview_label: Preview
1223
page_preview_url: /preview
24+
1325
page_installation_label: Install
1426
page_installation_url: /installation
27+
1528
page_vision_label: Vision
1629
page_vision_url: /vision
30+
1731
page_legal_label: Legal Terms
1832
page_legal_url: /legal
19-
page_tech_datastores_label: Data Stores in Org Check
20-
page_tech_datastores_url: /technical/datastores
21-
page_tech_ds_apexclasses_label: Apex Classes
22-
page_tech_ds_apexclasses_url: /technical/datastores/apexclasses
23-
page_tech_ds_flows_label: Flows
24-
page_tech_ds_flows_url: /technical/datastores/flows
25-
page_tech_ds_packages_label: Packages
26-
page_tech_ds_packages_url: /technical/datastores/packages
27-
page_tech_ds_workflowrules_label: Workflow Rules
28-
page_tech_ds_workflowrules_url: /technical/datastores/workflowrules
33+
34+
35+
##page_tech_datastores_label: Data Stores in OrgCheck
36+
##page_tech_datastores_url: /technical/datastores
37+
##page_tech_ds_apexclasses_label: Apex Classes
38+
##page_tech_ds_apexclasses_url: /technical/datastores/apexclasses
39+
##page_tech_ds_flows_label: Flows
40+
##page_tech_ds_flows_url: /technical/datastores/flows
41+
##page_tech_ds_packages_label: Packages
42+
##page_tech_ds_packages_url: /technical/datastores/packages
43+
##page_tech_ds_workflowrules_label: Workflow Rules
44+
##page_tech_ds_workflowrules_url: /technical/datastores/workflowrules

‎docs/_layouts/default.html‎

Lines changed: 45 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,65 @@
11
<!DOCTYPE html>
22
<html lang="{{ site.lang | default: "en-US" }}">
33
<head>
4-
<meta charset="UTF-8">
4+
<meta charset='utf-8'>
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<meta name="viewport" content="width=device-width, initial-scale=1">
6+
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
7+
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}" media="screen" type="text/css">
8+
<link rel="stylesheet" href="{{ '/assets/css/print.css' | relative_url }}" media="print" type="text/css">
79

8-
{% seo %}
9-
<link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
1010
<!--[if lt IE 9]>
11-
<script src="https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
11+
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
1212
<![endif]-->
13-
</head>
14-
<body>
15-
<div class="wrapper">
16-
<header>
17-
<h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repository_name }}</a></h1>
18-
19-
{% if site.logo %}
20-
<img src="{{site.logo | relative_url}}" alt="Logo" />
21-
{% endif %}
2213

23-
<p>{{ site.description | default: site.github.project_tagline }}</p>
14+
{% seo %}
15+
16+
{% include head-custom.html %}
17+
</head>
2418

19+
<body>
20+
<header>
21+
<div class="inner">
22+
<a href="{{ '/' | absolute_url }}">
23+
<h1>
24+
{% if site.show_imagetitle %}<img src="{{ site.imagetitle }}" width="300" />{% endif %}
25+
{% if site.show_title %}{{ site.title | default: site.github.repository_name }}{% endif %}
26+
</h1>
27+
</a>
28+
<h2>{{ site.description | default: site.github.project_tagline }}</h2>
2529
{% if site.github.is_project_page %}
26-
<p class="view"><a href="{{ site.github.repository_url }}" target="_blank" rel="external noopener noreferrer" >View the Project on GitHub <small>{{ site.github.repository_nwo }}</small></a></p>
30+
<a href="{{ site.github.repository_url }}" class="button"><small>View project on</small> GitHub</a>
2731
{% endif %}
28-
2932
{% if site.github.is_user_page %}
30-
<p class="view"><a href="{{ site.github.owner_url }}" target="_blank" rel="author noopener noreferrer">View My GitHub Profile</a></p>
33+
<a href="{{ site.github.owner_url }}" class="button"><small>Follow me on</small> GitHub</a>
3134
{% endif %}
35+
</div>
36+
</header>
3237

33-
<p>
34-
<strong>Menu:</strong><br />
35-
&rsaquo; &nbsp; <a href="{{ site.page_home_url | absolute_url }}">{{ site.page_home_label }}</a><br />
36-
&rsaquo; &nbsp; <a href="{{ site.page_preview_url | absolute_url }}">{{ site.page_preview_label }}</a><br />
37-
&rsaquo; &nbsp; <a href="{{ site.page_installation_url | absolute_url }}">{{ site.page_installation_label }}</a><br />
38-
&rsaquo; &nbsp; <a href="{{ site.page_vision_url | absolute_url }}">{{ site.page_vision_label }}</a><br />
39-
&rsaquo; &nbsp; Knowledge Sharing<br />
40-
&nbsp;&nbsp;&nbsp;&nbsp; &rsaquo;&rsaquo; &nbsp; <a style="font-size: smaller" href="{{ site.page_tech_datastores_url | absolute_url }}">{{ site.page_tech_datastores_label }}</a><br />
41-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &rsaquo;&rsaquo;&rsaquo; &nbsp; <a style="font-size: smaller" href="{{ site.page_tech_ds_apexclasses_url | absolute_url }}">{{ site.page_tech_ds_apexclasses_label }}</a><br />
42-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &rsaquo;&rsaquo;&rsaquo; &nbsp; <a style="font-size: smaller" href="{{ site.page_tech_ds_flows_url | absolute_url }}">{{ site.page_tech_ds_flows_label }}</a><br />
43-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &rsaquo;&rsaquo;&rsaquo; &nbsp; <a style="font-size: smaller" href="{{ site.page_tech_ds_packages_url | absolute_url }}">{{ site.page_tech_ds_packages_label }}</a><br />
44-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &rsaquo;&rsaquo;&rsaquo; &nbsp; <a style="font-size: smaller" href="{{ site.page_tech_ds_workflowrules_url | absolute_url }}">{{ site.page_tech_ds_workflowrules_label }}</a><br />
45-
&rsaquo; &nbsp; <a href="{{ site.page_legal_url | absolute_url }}">{{ site.page_legal_label }}</a><br />
46-
</p>
38+
<div id="content-wrapper">
39+
<div class="inner clearfix">
40+
<section id="main-content">
41+
{{ content }}
42+
</section>
4743

48-
{% if site.show_downloads %}
49-
<ul class="downloads">
50-
<li><a href="{{ site.github.zip_url }}">Download <strong>ZIP File</strong></a></li>
51-
<li><a href="{{ site.github.tar_url }}">Download <strong>TAR Ball</strong></a></li>
52-
<li><a href="{{ site.github.repository_url }}">View On <strong>GitHub</strong></a></li>
53-
</ul>
54-
{% endif %}
55-
</header>
56-
<section>
44+
<aside id="sidebar">
45+
{% if site.show_downloads %}
46+
<a href="{{ site.github.zip_url }}" class="button">
47+
<small>Download</small>
48+
.zip file
49+
</a>
50+
<a href="{{ site.github.tar_url }}" class="button">
51+
<small>Download</small>
52+
.tar.gz file
53+
</a>
54+
{% endif %}
5755

58-
{{ content }}
56+
{% if site.github.is_project_page %}
57+
<p class="repo-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</p>
58+
{% endif %}
5959

60-
</section>
61-
<footer>
62-
{% if site.github.is_project_page %}
63-
<p>This project is maintained by <a href="{{ site.github.owner_url }}" target="_blank" rel="author noopener noreferrer">{{ site.github.owner_name }}</a></p>
64-
{% endif %}
65-
<p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
66-
</footer>
60+
<p>This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</p>
61+
</aside>
62+
</div>
6763
</div>
68-
<script src="{{ "/assets/js/scale.fix.js" | relative_url }}"></script>
6964
</body>
7065
</html>

‎docs/assets/css/style.scss‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33

44
@import "{{ site.theme }}";
55

6-
header, footer {
7-
width: 200px;
8-
}
9-
section {
10-
width: 570px;
6+
header {
7+
background: #1c6067;
118
}

‎docs/index.md‎

Lines changed: 27 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -6,69 +6,46 @@ title: Welcome to Org Check
66

77
# Welcome to Org Check
88

9+
Let administrators, developers, customers and partners have an application within
10+
their Salesforce org to monitor and help **continuously reduce their technical debt**.
911

10-
## Introducing “Org Check”
12+
![Home Page tab screenshot](./images/screenshots/OrgCheck-Screenshot-Home.png)
1113

12-
Let customers have an application within their Salesforce org to reduce their technical debt continuously.
14+
## Why would you need this application in your org?
1315

14-
**How does it work?**
16+
Make sure your Salesforce organisation is under control in terms of **technical debt reduction**.
1517

16-
- You install this application directly in the org you want to analyse (sandbox or developer edition).
17-
- Then, you navigate through the tabs in the app to discover some bad practices in the org.
18-
- More information at (installation)
18+
You will need org Check to verify some things in your organisation like:
19+
- Well Described Data Model
20+
- Useful and meaningful Profiles and Permission Sets
21+
- Efficent Role Hierarchy
22+
- Active Users
23+
- Useful Public Groups and Queues
24+
- UI and Apex Componants respecting best practices
25+
- Better Automations
26+
- etc.
1927

28+
## My Vision of the application
2029

21-
**What are the use cases of the app?**
30+
This application is **easy to install and easy to use**.
31+
It requires no additional software or platform whatsoever.
32+
All you need is to install the application in your org from the AppExchange.
33+
No custom object will be added, no external connection, all stays in your browser and your org.
34+
The app is free of use: open sourced, available on the AppExchange for free and a support on slack and GitHub.
2235

23-
* Data Model
24-
* Get all information of an Object in a unique page
25-
* List all Org Wide Default in a unique page
26-
* Identity custom fields with bad practices
27-
* Profile and Permission Set
28-
* Identity custom profiles that are not assigned
29-
* Identity permission sets that are not assigned
30-
* Identify permission sets and profiles correlations
31-
* List IP and Login Hours restrictions on all profiles
32-
* Role hierarchy
33-
* Check if your role hierarchy is not too deep
34-
* Show role hierarchy in a diagram with empty roles identification
35-
* List roles with bad practices
36-
* Users
37-
* List users that never logged
38-
* Key system permissions for each users
39-
* Public group and Queues
40-
* List groups and queues
41-
* Identify all users of groups and queues (recursive computation)
42-
* UI Composants
43-
* List Visual Force pages and components with bad practices
44-
* List Aura and LWC components with bad practices
45-
* Apex Composants
46-
* List Apex Classes with bad practices (old API version, no explicit sharing, etc.)
47-
* List Triggers with bad practices (contains logic, DML, SOQL, etc.)
48-
* Automations
49-
* Workflow rules without actions
50-
* Process Builders / Flows
51-
* Batches
52-
* Failed jobs
53-
* Scheduled jobs
36+
Please use [this deck](http://sfdc.co/OrgCheck-Presentation) with your colleagues, company or customers to present the application before installing it and using it for your org.
5437

38+
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/VinceFINET/OrgCheck/issues.
5539

40+
## How do I install this application?
5641

57-
A complementary tool for the awesome **Salesforce Optimizer**.
42+
You install this application directly in the org you want to analyse from the AppExchange.
5843

44+
Then, you navigate through the tabs in the app to discover some bad practices in the org.
5945

46+
<a href="https://sfdc.co/OrgCheck-InstallToday-AppExchange" target="_blank"><img width="300" src="./assets/pngs/Install-AppExchange.png" alt="Deploy Org Check from AppExchange"></a><br />
6047

61-
## Install today!
62-
<a href="https://sfdc.co/OrgCheck-InstallToday-SDB"><img width="300" src="./assets/pngs/Install-SDBX.png" alt="Deploy Org Check to Salesforce (Sandbox)"></a><br />
63-
<a href="https://sfdc.co/OrgCheck-InstallToday-DE"><img width="300" src="./assets/pngs/Install-DevEdition.png" alt="Deploy Org Check to Salesforce (Dev Edition)"></a><br />
64-
65-
## Enjoy your ride with Checky (our mascot!)
66-
- [You want a preview of this application?](preview)
67-
- [How to install Org Check in your org?](installation)
68-
- [Why did I create this tool?](vision)
69-
- [Legal terms: Org Check is not a Salesforce product](legal)
70-
71-
48+
Any issues installing the application? Please, [go to this dedicated page](installation) about installation, including some frequently asked questions.
7249

7350
## How to get help and support?
7451

‎docs/legal.md‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/tech_datastore.md renamed to docs/old/tech_datastore.md

File renamed without changes.

docs/tech_datastore_apexclasses.md renamed to docs/old/tech_datastore_apexclasses.md

File renamed without changes.

docs/tech_datastore_flows.md renamed to docs/old/tech_datastore_flows.md

File renamed without changes.

docs/tech_datastore_packages.md renamed to docs/old/tech_datastore_packages.md

File renamed without changes.

docs/tech_datastore_workflowrules.md renamed to docs/old/tech_datastore_workflowrules.md

File renamed without changes.

0 commit comments

Comments
 (0)