mkdocs.yml

site_name: Sfdx-Hardis Documentation
site_url: https://sfdx-hardis.cloudity.com/
repo_url: https://github.com/hardisgroupcom/sfdx-hardis
edit_uri: tree/master/docs
site_author: Nicolas Vuillamy
site_description: Salesforce DX Plugin, by Cloudity.
copyright: Doc generated by <a href="https://sfdx-hardis.cloudity.com/hardis/doc/plugin/generate/" target="_blank">sfdx-hardis</a>
theme:
  name: material
  custom_dir: docs/overrides
  features:
    - content.code.copy
    - navigation.instant
    - navigation.footer
  logo: assets/images/cloudity-text-logo-white.svg
  favicon: assets/images/cloudity-logo.svg
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      background: "#F3F3F3"
      foreground: "#001135"
      colors:
        primary: "#0053FF"
        accent: "#660FF2"
        link: "#0053FF"
        header: "#001135"
        nav: "#F3F3F3"
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
      background: "#121212"
      foreground: "#FFFFFF"
      colors:
        primary: "#0053FF"
        accent: "#660FF2"
        link: "#0053FF"
        header: "#121212"
        nav: "#1A1A2E"
plugins:
  - glightbox
  - search
markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      base_path: docs
      check_paths: true
      restrict_base_path: false
  - mdx_truly_sane_lists
  - attr_list
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - md_in_html
extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - javascripts/tables.js
  - javascripts/gtag.js
extra_css:
  - stylesheets/extra.css
extra:
  social:
    - icon: fontawesome/regular/circle-question
      link: https://github.com/hardisgroupcom/sfdx-hardis/issues
      title: Need help ? Post an issue :)
    - icon: fontawesome/brands/github
      link: https://github.com/hardisgroupcom/sfdx-hardis
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/hardisgroupcom/sfdx-hardis/tags
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/NicolasVuillamy
  generator: false
nav:
  - Home: index.md
  - Installation: installation.md
  - Salesforce CI/CD:
      - CI/CD Home: salesforce-ci-cd-home.md
      - Contributor Guide:
          - Contributor Guide Home: salesforce-ci-cd-use-home.md
          - Pre-requisites:
              - Prepare your computer: salesforce-ci-cd-use-install.md
              - Clone the repository: salesforce-ci-cd-clone-repository.md
          - Create new User Story: salesforce-ci-cd-create-new-task.md
          - Work on your dev org:
              - Work home: salesforce-ci-cd-work-on-task.md
              - Open your org: salesforce-ci-cd-work-on-task-open-org.md
              - Configure Salesforce: salesforce-ci-cd-work-on-task-configuration.md
              - Handle Profiles: salesforce-ci-cd-work-on-task-profiles.md
              - Install packages: salesforce-ci-cd-work-on-task-install-packages.md
              - Deployment actions (beta): salesforce-ci-cd-work-on-task-deployment-actions.md
              - Develop in Salesforce: salesforce-ci-cd-work-on-task-development.md
          - Save / Publish your User Story: salesforce-ci-cd-publish-task.md
          - Create Pull Request:
              - On Gitlab: salesforce-ci-cd-merge-request-gitlab.md
              - On Azure: salesforce-ci-cd-pull-request-azure.md
              - On Github: salesforce-ci-cd-pull-request-github.md
          - Check Pull Request results:
              - Merge Request results Home: salesforce-ci-cd-handle-merge-request-results.md
              - Solve deployment errors: salesforce-ci-cd-solve-deployment-errors.md
              - Solve MegaLinter errors: salesforce-ci-cd-solve-megalinter-errors.md
      - Release Manager Guide:
          - Release Manager Home: salesforce-ci-cd-release-home.md
          - Validate a merge request: salesforce-ci-cd-validate-merge-request.md
          - Deploy to major orgs: salesforce-ci-cd-deploy-major-branches.md
          - Handle RUN / Hotfix to Production: salesforce-ci-cd-hotfixes.md
          - CI/CD Configuration:
              - CI/CD Config Home: salesforce-ci-cd-config-home.md
              - Overwrite Management: salesforce-ci-cd-config-overwrite.md
              - Delta deployments: salesforce-ci-cd-config-delta-deployment.md
              - Automated cleaning: salesforce-ci-cd-config-cleaning.md
              - Source retrieve issues: salesforce-ci-cd-retrieve.md
              - Auxiliary repository clean up tasks: salesforce-ci-cd-manual-repo-clean.md
          - sfdx-hardis for packaging: salesforce-ci-cd-packaging.md
          - sfdx-hardis for Conga: salesforce-ci-cd-conga.md
          - sfdx-hardis for CPQ: salesforce-ci-cd-cpq.md
      - Setup Guide:
          - CI/CD Setup Home: salesforce-ci-cd-setup-home.md
          - Init Git repository: salesforce-ci-cd-setup-git.md
          - Configure Orgs: salesforce-ci-cd-setup-activate-org.md
          - Init SFDX Project: salesforce-ci-cd-setup-init-project.md
          - CI Server Authentication: salesforce-ci-cd-setup-auth.md
          - Init from Existing Org: salesforce-ci-cd-setup-existing-org.md
          - Integrations:
              - Integrations Home: salesforce-ci-cd-setup-integrations-home.md
              - GitHub: salesforce-ci-cd-setup-integration-github.md
              - Gitlab: salesforce-ci-cd-setup-integration-gitlab.md
              - Azure DevOps: salesforce-ci-cd-setup-integration-azure.md
              - BitBucket: salesforce-ci-cd-setup-integration-bitbucket.md
              - Jenkins: salesforce-ci-cd-setup-integration-jenkins.md
              - Slack: salesforce-ci-cd-setup-integration-slack.md
              - Microsoft Teams: salesforce-ci-cd-setup-integration-ms-teams.md
              - Email: salesforce-ci-cd-setup-integration-email.md
              - Grafana: salesforce-ci-cd-setup-integration-api.md
              - Jira: salesforce-ci-cd-setup-integration-jira.md
              - Azure Boards: salesforce-ci-cd-setup-integration-azure-boards.md
              - Generic Ticketing: salesforce-ci-cd-setup-integration-generic-ticketing.md
          - First merge request: salesforce-ci-cd-setup-merge-request.md
      - Smart Deploy Workflow: salesforce-ci-cd-smart-deployment.md
  - Org Monitoring:
      - Monitoring home: salesforce-monitoring-home.md
      - List of checks:
          - Metadata Backup: salesforce-monitoring-metadata-backup.md
          - Suspect Setup Actions: salesforce-monitoring-suspect-audit-trail.md
          - Apex tests: salesforce-monitoring-apex-tests.md
          - Quality Checks with MegaLinter: salesforce-monitoring-quality-checks.md
          - Apex and Flow errors: salesforce-monitoring-apex-flow-errors.md
          - Limits issues: salesforce-monitoring-org-limits.md
          - Apex flex queue: salesforce-monitoring-apex-flex-queue.md
          - Calls to deprecated API versions: salesforce-monitoring-deprecated-api-calls.md
          - Unsecured Connected Apps: salesforce-monitoring-unsecured-connected-apps.md
          - Licenses overview: salesforce-monitoring-licenses-overview.md
          - Org and instance upgrade info: salesforce-monitoring-org-instance-upgrade.md
          - Release Updates: salesforce-monitoring-release-updates.md
          - Security Health Check: salesforce-monitoring-health-check.md
          - Inactive users: salesforce-monitoring-inactive-users.md
          - Unused licenses: salesforce-monitoring-unused-licenses.md
          - Unused Apex Classes: salesforce-monitoring-unused-apex-classes.md
          - Unused Connected Apps: salesforce-monitoring-unused-connected-apps.md
          - Metadatas without access: salesforce-monitoring-missing-access.md
          - Unused Custom Labels: salesforce-monitoring-unused-metadata.md
          - Inactive metadata: salesforce-monitoring-inactive-metadata.md
          - Missing metadata attributes: salesforce-monitoring-missing-metadata-attributes.md
          - Underused Permission Sets: salesforce-monitoring-underused-permsets.md
      - Configuration:
          - Configuration guide: salesforce-monitoring-config-home.md
          - GitHub: salesforce-monitoring-config-github.md
          - Gitlab: salesforce-monitoring-config-gitlab.md
          - Azure: salesforce-monitoring-config-azure.md
          - Bitbucket: salesforce-monitoring-config-bitbucket.md
          - Slack: salesforce-ci-cd-setup-integration-slack.md
          - Microsoft Teams: salesforce-ci-cd-setup-integration-ms-teams.md
  - Generate Org Documentation:
      - Doc Gen Home: salesforce-project-documentation.md
      - Generate: salesforce-project-doc-generate.md
      - Improve with AI: salesforce-project-doc-ai.md
      - Complete manually: salesforce-project-doc-complete-manually.md
      - Mermaid Theme Overrides: salesforce-project-doc-mermaid-theme.md
      - Host on Salesforce: salesforce-project-doc-host-on-salesforce.md
      - Host on Cloudflare: salesforce-project-doc-cloudflare.md
      - Publish to Confluence: salesforce-project-doc-confluence.md
  - AI Deployment Assistant:
      - Deployment Assistant home: salesforce-deployment-assistant-home.md
      - Configuration:
          - Setup Deployment Assistant: salesforce-deployment-assistant-setup.md
          - Setup AI integration: salesforce-ai-setup.md
      - Deployment errors list: salesforce-deployment-assistant-error-list.md
  - Integrations:
      - Integrations Home: salesforce-ci-cd-setup-integrations-home.md
      - GitHub: salesforce-ci-cd-setup-integration-github.md
      - Gitlab: salesforce-ci-cd-setup-integration-gitlab.md
      - Azure DevOps: salesforce-ci-cd-setup-integration-azure.md
      - BitBucket: salesforce-ci-cd-setup-integration-bitbucket.md
      - Slack: salesforce-ci-cd-setup-integration-slack.md
      - Microsoft Teams: salesforce-ci-cd-setup-integration-ms-teams.md
      - Email: salesforce-ci-cd-setup-integration-email.md
      - Grafana: salesforce-ci-cd-setup-integration-api.md
      - Jira: salesforce-ci-cd-setup-integration-jira.md
      - Azure Boards: salesforce-ci-cd-setup-integration-azure-boards.md
      - Generic Ticketing: salesforce-ci-cd-setup-integration-generic-ticketing.md
      - LLM Providers:
          - LLM home: salesforce-ai-setup.md
          - Prompts:
              - All prompts: salesforce-ai-prompts.md
              - Complete Object Attributes: prompt-templates/PROMPT_COMPLETE_OBJECT_ATTRIBUTES_MD.md
              - Describe Apex: prompt-templates/PROMPT_DESCRIBE_APEX.md
              - Describe Approval Process: prompt-templates/PROMPT_DESCRIBE_APPROVAL_PROCESS.md
              - Describe Assignment Rules: prompt-templates/PROMPT_DESCRIBE_ASSIGNMENT_RULES.md
              - Describe AutoResponse Rules: prompt-templates/PROMPT_DESCRIBE_AUTORESPONSE_RULES.md
              - Describe Escalation Rules: prompt-templates/PROMPT_DESCRIBE_ESCALATION_RULES.md
              - Describe Flow: prompt-templates/PROMPT_DESCRIBE_FLOW.md
              - Describe Flow Diff: prompt-templates/PROMPT_DESCRIBE_FLOW_DIFF.md
              - Describe LWC: prompt-templates/PROMPT_DESCRIBE_LWC.md
              - Describe Object: prompt-templates/PROMPT_DESCRIBE_OBJECT.md
              - Describe Package: prompt-templates/PROMPT_DESCRIBE_PACKAGE.md
              - Describe Page: prompt-templates/PROMPT_DESCRIBE_PAGE.md
              - Describe Permission Set: prompt-templates/PROMPT_DESCRIBE_PERMISSION_SET.md
              - Describe Permission Set Group: prompt-templates/PROMPT_DESCRIBE_PERMISSION_SET_GROUP.md
              - Describe Profile: prompt-templates/PROMPT_DESCRIBE_PROFILE.md
              - Describe Roles: prompt-templates/PROMPT_DESCRIBE_ROLES.md
              - Solve Deployment Error: prompt-templates/PROMPT_SOLVE_DEPLOYMENT_ERROR.md
              - Variables:
                  - Additional Instructions: prompt-templates/VARIABLE_ADDITIONAL_INSTRUCTIONS.md
                  - Formatting Requirements: prompt-templates/VARIABLE_FORMATTING_REQUIREMENTS.md
                  - Output Format Markdown Doc: prompt-templates/VARIABLE_OUTPUT_FORMAT_MARKDOWN_DOC.md
  - Sandbox Refresh: salesforce-sandbox-refresh.md
  - Commands:
      All commands: commands.md
      hardis:
        auth:
          login: hardis/auth/login.md
        cache:
          clear: hardis/cache/clear.md
        config:
          get: hardis/config/get.md
        datacloud:
          extract:
            agentforce-conversations: hardis/datacloud/extract/agentforce-conversations.md
            agentforce-feedback: hardis/datacloud/extract/agentforce-feedback.md
          sql-query: hardis/datacloud/sql-query.md
        doc:
          extract:
            permsetgroups: hardis/doc/extract/permsetgroups.md
          fieldusage: hardis/doc/fieldusage.md
          flow2markdown: hardis/doc/flow2markdown.md
          mkdocs-to-cf: hardis/doc/mkdocs-to-cf.md
          mkdocs-to-confluence: hardis/doc/mkdocs-to-confluence.md
          mkdocs-to-salesforce: hardis/doc/mkdocs-to-salesforce.md
          object-field-usage: hardis/doc/object-field-usage.md
          override-prompts: hardis/doc/override-prompts.md
          packagexml2markdown: hardis/doc/packagexml2markdown.md
          plugin:
            generate: hardis/doc/plugin/generate.md
          project2markdown: hardis/doc/project2markdown.md
        git:
          pull-requests:
            extract: hardis/git/pull-requests/extract.md
        lint:
          access: hardis/lint/access.md
          metadatastatus: hardis/lint/metadatastatus.md
          missingattributes: hardis/lint/missingattributes.md
          unusedmetadatas: hardis/lint/unusedmetadatas.md
        mdapi:
          deploy: hardis/mdapi/deploy.md
        misc:
          custom-label-translations: hardis/misc/custom-label-translations.md
          purge-references: hardis/misc/purge-references.md
          servicenow-report: hardis/misc/servicenow-report.md
          toml2csv: hardis/misc/toml2csv.md
        org:
          community:
            update: hardis/org/community/update.md
          configure:
            data: hardis/org/configure/data.md
            files: hardis/org/configure/files.md
            monitoring: hardis/org/configure/monitoring.md
          connect: hardis/org/connect.md
          create: hardis/org/create.md
          data:
            delete: hardis/org/data/delete.md
            export: hardis/org/data/export.md
            import: hardis/org/data/import.md
          diagnose:
            apex-api-version: hardis/org/diagnose/apex-api-version.md
            audittrail: hardis/org/diagnose/audittrail.md
            deployments: hardis/org/diagnose/deployments.md
            flex-queue: hardis/org/diagnose/flex-queue.md
            instanceupgrade: hardis/org/diagnose/instanceupgrade.md
            legacyapi: hardis/org/diagnose/legacyapi.md
            licenses: hardis/org/diagnose/licenses.md
            minimalpermsets: hardis/org/diagnose/minimalpermsets.md
            releaseupdates: hardis/org/diagnose/releaseupdates.md
            storage-stats: hardis/org/diagnose/storage-stats.md
            underusedpermsets: hardis/org/diagnose/underusedpermsets.md
            unsecure-connected-apps: hardis/org/diagnose/unsecure-connected-apps.md
            unused-apex-classes: hardis/org/diagnose/unused-apex-classes.md
            unused-connected-apps: hardis/org/diagnose/unused-connected-apps.md
            unusedlicenses: hardis/org/diagnose/unusedlicenses.md
            unusedusers: hardis/org/diagnose/unusedusers.md
          files:
            export: hardis/org/files/export.md
            import: hardis/org/files/import.md
          fix:
            listviewmine: hardis/org/fix/listviewmine.md
          generate:
            packagexmlfull: hardis/org/generate/packagexmlfull.md
          monitor:
            all: hardis/org/monitor/all.md
            backup: hardis/org/monitor/backup.md
            errors: hardis/org/monitor/errors.md
            health-check: hardis/org/monitor/health-check.md
            limits: hardis/org/monitor/limits.md
          multi-org-query: hardis/org/multi-org-query.md
          purge:
            apexlog: hardis/org/purge/apexlog.md
            flow: hardis/org/purge/flow.md
            profile: hardis/org/purge/profile.md
          refresh:
            after-refresh: hardis/org/refresh/after-refresh.md
            before-refresh: hardis/org/refresh/before-refresh.md
          retrieve:
            packageconfig: hardis/org/retrieve/packageconfig.md
            sources:
              analytics: hardis/org/retrieve/sources/analytics.md
              dx: hardis/org/retrieve/sources/dx.md
              dx2: hardis/org/retrieve/sources/dx2.md
              metadata: hardis/org/retrieve/sources/metadata.md
              retrofit: hardis/org/retrieve/sources/retrofit.md
          select: hardis/org/select.md
          test:
            apex: hardis/org/test/apex.md
          user:
            activateinvalid: hardis/org/user/activateinvalid.md
            freeze: hardis/org/user/freeze.md
            unfreeze: hardis/org/user/unfreeze.md
        package:
          create: hardis/package/create.md
          install: hardis/package/install.md
          mergexml: hardis/package/mergexml.md
          version:
            create: hardis/package/version/create.md
            list: hardis/package/version/list.md
            promote: hardis/package/version/promote.md
        packagexml:
          append: hardis/packagexml/append.md
          remove: hardis/packagexml/remove.md
        project:
          audit:
            apiversion: hardis/project/audit/apiversion.md
            callincallout: hardis/project/audit/callincallout.md
            duplicatefiles: hardis/project/audit/duplicatefiles.md
            remotesites: hardis/project/audit/remotesites.md
          clean:
            emptyitems: hardis/project/clean/emptyitems.md
            filter-xml-content: hardis/project/clean/filter-xml-content.md
            flowpositions: hardis/project/clean/flowpositions.md
            hiddenitems: hardis/project/clean/hiddenitems.md
            listviews: hardis/project/clean/listviews.md
            manageditems: hardis/project/clean/manageditems.md
            minimizeprofiles: hardis/project/clean/minimizeprofiles.md
            orgmissingitems: hardis/project/clean/orgmissingitems.md
            profiles-extract: hardis/project/clean/profiles-extract.md
            references: hardis/project/clean/references.md
            retrievefolders: hardis/project/clean/retrievefolders.md
            sensitive-metadatas: hardis/project/clean/sensitive-metadatas.md
            standarditems: hardis/project/clean/standarditems.md
            systemdebug: hardis/project/clean/systemdebug.md
            xml: hardis/project/clean/xml.md
          configure:
            auth: hardis/project/configure/auth.md
          convert:
            profilestopermsets: hardis/project/convert/profilestopermsets.md
          create: hardis/project/create.md
          deploy:
            notify: hardis/project/deploy/notify.md
            quick: hardis/project/deploy/quick.md
            simulate: hardis/project/deploy/simulate.md
            smart: hardis/project/deploy/smart.md
            sources:
              dx: hardis/project/deploy/sources/dx.md
              metadata: hardis/project/deploy/sources/metadata.md
            start: hardis/project/deploy/start.md
            validate: hardis/project/deploy/validate.md
          fix:
            profiletabs: hardis/project/fix/profiletabs.md
            v53flexipages: hardis/project/fix/v53flexipages.md
          generate:
            bypass: hardis/project/generate/bypass.md
            flow-git-diff: hardis/project/generate/flow-git-diff.md
            gitdelta: hardis/project/generate/gitdelta.md
          lint: hardis/project/lint.md
          metadata:
            activate-decomposed: hardis/project/metadata/activate-decomposed.md
            findduplicates: hardis/project/metadata/findduplicates.md
        deploy:
          quick: hardis/deploy/quick.md
          start: hardis/deploy/start.md
          validate: hardis/deploy/validate.md
        scratch:
          create: hardis/scratch/create.md
          delete: hardis/scratch/delete.md
          pool:
            create: hardis/scratch/pool/create.md
            localauth: hardis/scratch/pool/localauth.md
            refresh: hardis/scratch/pool/refresh.md
            reset: hardis/scratch/pool/reset.md
            view: hardis/scratch/pool/view.md
          pull: hardis/scratch/pull.md
          push: hardis/scratch/push.md
        source:
          deploy: hardis/source/deploy.md
          push: hardis/source/push.md
          retrieve: hardis/source/retrieve.md
        work:
          new: hardis/work/new.md
          refresh: hardis/work/refresh.md
          resetselection: hardis/work/resetselection.md
          save: hardis/work/save.md
          ws: hardis/work/ws.md
      hello:
        world: hello/world.md
  - Community Events: events.md
  - Articles & Videos: articles-videos.md
  - Meet the team: contributors.md
  - Configuration reference: sfdx-hardis-config-file.md
  - Frequently Asked Questions: https://nicolas.vuillamy.fr/what-devops-experts-want-to-know-about-salesforce-ci-cd-with-sfdx-hardis-q-a-1f412db34476
  - Contributing: contributing.md
  - Plugins: sfdx-hardis-plugins.md
  - License: license.md
  - Security: SECURITY.md
  - Changelog: CHANGELOG.md
  - Help: sfdx-hardis-help.md
  - Cloudity, Consulting Partner: cloudity-consulting-partner.md