[doc] Issue in "Intro"

[peteingithub]

Intro:

https://documentation.suse.com/suse-edge/3.0/html/edge/id-air-gapped-deployments-with-edge-image-builder.html#id-intro

Throughout this documentation I see terms artifact and artefact. Which of the is correct?

[hardys]

I think this is a British vs US English issue - perhaps @ranjinimn can provide guidance re which spelling we should align with then we can do a sed replacement to ensure consistency

[peteingithub]

Does EIB not have ’artefact’ as a directory name?

to 22.8.2024 klo 14.39 Steven Hardy @.***> kirjoitti:

I think this is a British vs US English issue - perhaps @ranjinimn https://github.com/ranjinimn can provide guidance re which spelling we should align with then we can do a sed replacement to ensure consistency

— Reply to this email directly, view it on GitHub https://github.com/suse-edge/suse-edge.github.io/issues/351#issuecomment-2304453925, or unsubscribe https://github.com/notifications/unsubscribe-auth/AUWPCJ6JLQ73MTX54PROV63ZSXEVNAVCNFSM6AAAAABM3SHTFWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMBUGQ2TGOJSGU . You are receiving this because you authored the thread.Message ID: @.***>

[hardys]

Does EIB not have ’artefact’ as a directory name?

See https://github.com/suse-edge/edge-image-builder/issues/519

[ranjinimn]

@hardys and @peteingithub We write documentation in American English. Where spelling differences exist between American and British English, use the American English variant. However, I see that we have defined both "Artifact" (US) and "artefact" (British) defined in our directories and scripts. You will have to change at the code level for me to make the changes in the document.

[hardys]

Indeed it seems we will need to make code changes to EIB and rename the scripts in the fleet-examples repo to fully resolve this

[ranjinimn]

@hardys Can you please let me know the SME who can help me with this information?

[hardys]

@hardys Can you please let me know the SME who can help me with this information?

I would suggest discussing with @jdob since I don't think this can be fixed purely in docs, we need to decide how to handle the EIB API changes ref https://github.com/suse-edge/edge-image-builder/issues/519 (I guess we'll have to handle both versions at least for a period of time if we want to migrate the spelling)

[jdob]

re: "artifact" -- for all documentation, it should be "artifact". There may be one user-visible place where we use "artefact", but its in a build artifacts directory and not something a user will commonly interact with, only for debugging. That said, we should address the bug linked. But outside of that, it shouldn't involve any sort of API issue since we used the American spelling in the image definition.