Problems in creation of multilanguage org documentations

[mec0202]

Hi, I am currently testing a bit with the org documentation creation in multiple languages + deploying this to Cloudflare.
This is setup via our Github Ci/CD Workflow file. Here a code snippet from the relevant lines of our file:

          SFDX_DOC_LANGUAGES: en,de
          CLOUDFLARE_PROJECT_NAME_EN: Documentation-en
          CLOUDFLARE_PROJECT_NAME_DE: Documentation-de
          SFDX_HARDIS_DOC_DEPLOY_TO_CLOUDFLARE: true
          AI_MAX_TIMEOUT_MINUTES: 240

        run: |
          echo "Monitoring sfdx-hardis: Metadata Backup for \"$CONFIG_BRANCH\""
          sf hardis:auth:login
          sf hardis:org:monitor:backup

What is see in the repository / in the created documentation on Cloudflare:

• in the cache-ai-results folder there is for every affected metadata always a language specific .md file
  Example: de-PROMPT_DESCRIBE_APEX-Controller1.md; en-PROMPT_DESCRIBE_APEX-Controller1.md

• in /docs there is always only one file per metadata (no differentiation based on language) and here the language is not consistent.
  Example: the content of the md file /docs/apex/Controller1 is in english language; the content of the md file /docs/apex/Controller2 is in german language

• the content of the Cloudflare "german" project and the Cloudflare "english" project is the same and follows the language based on the /docs folder.
  Example: The ai enriched content for "Controller1" is written on both projects in english

What have I done wrong in the setup that both languages basically got mixed up in the final created documentation?

Greetings

[nvuillam]

did you try that ? :)

• If you want to generate the documentation in multiple languages, define variable SFDX_DOC_LANGUAGES (ex: SFDX_DOC_LANGUAGES=en,fr,de)
• You can define one Cloudflare site by language, for example with the following variables:
  • CLOUDFLARE_PROJECT_NAME_EN=cloudity-demo-english
  • CLOUDFLARE_PROJECT_NAME_FR=cloudity-demo-french
  • CLOUDFLARE_PROJECT_NAME_DE=cloudity-demo-german

The last language will always be the one stored, but during backup command, it will generate + push to cloudflare in each language :)

Note: the language is applied only for AI-generated summary, the "structure" will always be in english

if it can help, the related code is here ->

sfdx-hardis/src/commands/hardis/org/monitor/backup.ts

Line 321 in d5922d4

const docLanguages = (getEnvVar('SFDX_DOC_LANGUAGES') || getEnvVar('PROMPTS_LANGUAGE') || 'en').split(",").reverse(); // Can be 'fr,en,de' for example

[mec0202]

Thank you, before I will do that let me try to clear the md files so that they will be generated new and pushed to cloudflare (Ai cache should stay). I tested some thing in the last days and maybe (this is eventually the case) I did something wrong.

[mec0202]

@nvuillam I tried to debug the file by myself (with a bit of help by Gemini).
In the log I see, that

• on the first run (generation for german language) everything went well, all was generated
• on the second run (generation for english content) in the context of the english version:

1. The Flow generation was skipped ([sfdx-hardis] Skipped generation for 24 Flows that have not been updated:)
2. The Apex generation has an error:

[sfdx-hardis] Error generating Apex documentation: {}
[sfdx-hardis] TypeError: options.fn is not a function

Gemini is saying that eventually there are some leftovers from the first run (because if reuse of the helpers).

Result: No markdown for german language for these metadata was created, the already existing english markdown files have been then in the end used in the deployment for the german cloudflare project.

If I remember correct: I already tried it in the beginning as you also write in the documentation to manually set this "mkdocs creation + deployment comments" inside of the Worklfow file (Custom pipeline approach) and therefore not to use the org documentation generation inside of sf hardis:org:monitor:backup command.

Based on your answer and your plans I guess I will continue with that approach

[nvuillam]

@mec0202 you seem to be on the good path, thanks :)

[mec0202]

Nevertheless I am open for testing again in case you will change something based on the all in one sf hardis:org:monitor:backup command. Let me just know;).
Greetings

[nvuillam]

@mec0202 i have a huge backlog, and multilingual doc is at the bottom of it... it will be faster if you debug it ;)