Skip to content

Commit

Permalink
Generate doc (#434)
Browse files Browse the repository at this point in the history 
* Generate doc

* [Mega-Linter] Apply linters fixes

---------

Co-authored-by: nvuillam <nvuillam@users.noreply.github.com>
  • Loading branch information
@nvuillam
nvuillam and nvuillam authored Oct 3, 2023
1 parent 7a20d9d commit 4ddeb59
Show file tree
Hide file tree
Showing 19 changed files with 346 additions and 270 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Note: Can be used with `sfdx plugins:install sfdx-hardis@beta` and docker image `hardisgroupcom/sfdx-hardis@beta`

- Update documentation

## [4.6.4] 2023-09-28

- hardis:work:save : Fix issue when there is an empty commit because of pre-commit hooks
Expand Down
354 changes: 178 additions & 176 deletions README.md
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
| [**hardis:org:diagnose:legacyapi**](hardis/org/diagnose/legacyapi.md) | Check for legacy API use |
| [**hardis:org:files:export**](hardis/org/files/export.md) | Export files |
| [**hardis:org:fix:listviewmine**](hardis/org/fix/listviewmine.md) | Fix listviews with |
| [**hardis:org:generate:packagexmlfull**](hardis/org/generate/packagexmlfull.md) | Generate Full Org package.xml |
| [**hardis:org:purge:apexlog**](hardis/org/purge/apexlog.md) | Purge Apex Logs |
| [**hardis:org:purge:flow**](hardis/org/purge/flow.md) | Purge Flow versions |
| [**hardis:org:retrieve:packageconfig**](hardis/org/retrieve/packageconfig.md) | Retrieve package configuration from an org |
Expand Down
14 changes: 7 additions & 7 deletions docs/deployTips.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: Learn how to fix issues that can happen during sfdx deployments

This page summarizes all errors that can be detected by sfdx-hardis wrapper commands

| sfdx command | sfdx-hardis wrapper command |
| :----------- | :-------------------------- |
| [sfdx force:source:deploy](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_deploy) | [sfdx hardis:source:deploy](https://sfdx-hardis.cloudity.com/hardis/source/deploy/) |
| [sfdx force:source:push](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_push) | [sfdx hardis:source:push](https://sfdx-hardis.cloudity.com/hardis/source/push/) |
| [sfdx force:mdapi:deploy](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_mdapi.htm#cli_reference_force_mdapi_beta_deploy) | [sfdx hardis:mdapi:deploy](https://sfdx-hardis.cloudity.com/hardis/mdapi/deploy/) |
| sfdx command | sfdx-hardis wrapper command |
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------|
| [sfdx force:source:deploy](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_deploy) | [sfdx hardis:source:deploy](https://sfdx-hardis.cloudity.com/hardis/source/deploy/) |
| [sfdx force:source:push](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_push) | [sfdx hardis:source:push](https://sfdx-hardis.cloudity.com/hardis/source/push/) |
| [sfdx force:mdapi:deploy](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_mdapi.htm#cli_reference_force_mdapi_beta_deploy) | [sfdx hardis:mdapi:deploy](https://sfdx-hardis.cloudity.com/hardis/mdapi/deploy/) |

You can also use this function on a [sfdx-hardis Salesforce CI/CD project](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-home/)

Expand Down Expand Up @@ -302,7 +302,7 @@ You probably also need to add CRM Analytics Admin Permission Set assignment to t
## Error parsing file
- `Error (.*) Error parsing file: (.*) `
- `Error (.*) Error parsing file: (.*)`
**Resolution tip**
Expand Down Expand Up @@ -902,7 +902,7 @@ Please check https://developer.salesforce.com/forums/?id=9060G0000005kVLQAY
## Test classes with 0% coverage
- ` 0%`
- `0%`
**Resolution tip**
Expand Down
35 changes: 35 additions & 0 deletions docs/hardis/org/generate/packagexmlfull.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!-- This file has been generated with command 'sfdx hardis:doc:plugin:generate'. Please do not update it manually or it may be overwritten -->
# hardis:org:generate:packagexmlfull

## Description

Generates full org package.xml, including managed items

## Parameters

| Name | Type | Description | Default | Required | Options |
|:----------------------|:-------:|:--------------------------------------------------------------------|:-------:|:--------:|:-----------------------------------------------------:|
| apiversion | option | override the api version used for api requests made by this command | | | |
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| json | boolean | format output as json | | | |
| loglevel | option | logging level for this command invocation | warn | | trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal |
| outputfile | option | Output package.xml file | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| targetusername<br/>-u | option | username or alias for the target org; overrides default target org | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

```shell
sfdx hardis:org:generate:packagexmlfull
```

```shell
sfdx hardis:org:generate:packagexmlfull --outputfile /tmp/packagexmlfull.xml
```

```shell
sfdx hardis:org:generate:packagexmlfull --targetusername nico@example.com
```


28 changes: 14 additions & 14 deletions docs/hardis/org/purge/flow.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ Purge Obsolete flow versions to avoid the 50 max versions limit. Filters on Stat

## Parameters

| Name | Type | Description | Default | Required | Options | |
|:-------------------------|:-------:|:------------------------------------------------------------------------------------|:-------------------------------:|:--------:|:-----------------------------------------------------:|---|
| allowpurgefailure<br/>-f | boolean | Allows purges to fail without exiting with 1. Use --no-allowpurgefailure to disable | | | | |
| apiversion | option | override the api version used for api requests made by this command | | | | |
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | | |
| instanceurl<br/>-r | option | URL of org instance | <<https://login.salesforce.com> | | | > |
| json | boolean | format output as json | | | | |
| loglevel | option | logging level for this command invocation | warn | | trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal | |
| name<br/>-n | option | Filter according to Name criteria | | | | |
| prompt<br/>-z | boolean | Prompt for confirmation (true by default, use --no-prompt to skip) | | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | | |
| status<br/>-s | option | Filter according to Status criteria | | | | |
| targetusername<br/>-u | option | username or alias for the target org; overrides default target org | | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | | |
| Name | Type | Description | Default | Required | Options |
|:-------------------------|:-------:|:------------------------------------------------------------------------------------|:------------------------------:|:--------:|:-----------------------------------------------------:|
| allowpurgefailure<br/>-f | boolean | Allows purges to fail without exiting with 1. Use --no-allowpurgefailure to disable | | | |
| apiversion | option | override the api version used for api requests made by this command | | | |
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| instanceurl<br/>-r | option | URL of org instance | <https://login.salesforce.com> | | |
| json | boolean | format output as json | | | |
| loglevel | option | logging level for this command invocation | warn | | trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal |
| name<br/>-n | option | Filter according to Name criteria | | | |
| prompt<br/>-z | boolean | Prompt for confirmation (true by default, use --no-prompt to skip) | | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| status<br/>-s | option | Filter according to Status criteria | | | |
| targetusername<br/>-u | option | username or alias for the target org; overrides default target org | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

Expand Down
4 changes: 4 additions & 0 deletions docs/hardis/org/retrieve/sources/metadata.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,8 @@ Retrieve Salesforce DX project from org
sfdx hardis:org:retrieve:sources:metadata
```

```shell
SFDX_RETRIEVE_WAIT_MINUTES=200 sfdx hardis:org:retrieve:sources:metadata
```


2 changes: 2 additions & 0 deletions docs/hardis/org/test/apex.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ If following configuration is defined, it will fail if apex coverage target is n
- Env `APEX_TESTS_MIN_COVERAGE_ORG_WIDE` or `.sfdx-hardis` property `apexTestsMinCoverageOrgWide`
- Env `APEX_TESTS_MIN_COVERAGE_ORG_WIDE` or `.sfdx-hardis` property `apexTestsMinCoverageOrgWide`

You can override env var SFDX_TEST_WAIT_MINUTES to wait more than 60 minutes


## Parameters

Expand Down
18 changes: 9 additions & 9 deletions docs/hardis/project/audit/duplicatefiles.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@

## Description

Find duplicate files in sfdx folder (often from past sfdx-cli bugs)
Find duplicate files in sfdx folder (often from past @salesforce/cli bugs)

## Parameters

| Name | Type | Description | Default | Required | Options |
|:-------------|:-------:|:--------------------------------------------------------------|:----------------------:|:--------:|:-----------------------------------------------------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| json | boolean | format output as json | | | |
| loglevel | option | logging level for this command invocation | warn | | trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal |
| path<br/>-p | option | Root path to check | D:\git\sfdx-hardis1703 | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |
| Name | Type | Description | Default | Required | Options |
|:-------------|:-------:|:--------------------------------------------------------------|:------------------:|:--------:|:-----------------------------------------------------:|
| debug<br/>-d | boolean | Activate debug mode (more logs) | | | |
| json | boolean | format output as json | | | |
| loglevel | option | logging level for this command invocation | warn | | trace<br/>debug<br/>info<br/>warn<br/>error<br/>fatal |
| path<br/>-p | option | Root path to check | C:\git\sfdx-hardis | | |
| skipauth | boolean | Skip authentication check when a default username is required | | | |
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration | | | |

## Examples

Expand Down
Loading

0 comments on commit 4ddeb59

Please sign in to comment.