Add Persian (fa) edition for API Security 2023

[This-is-Neo]

Add Persian (fa) edition for API Security 2023

[This-is-Neo]

134

[This-is-Neo]

Hi @This-is-Neo, The PR needs some changes before becoming ready for merge. Please kindly review my comments.

Remember that you can render the site locally using docker. To add the Persian translation to the languages selector you should do the following change:

diff --git a/editions/2023/mkdocs.yml b/editions/2023/mkdocs.yml
index e4f73e3..505c4d2 100644
--- a/editions/2023/mkdocs.yml
+++ b/editions/2023/mkdocs.yml
@@ -9,3 +9,5 @@ extra:
       lang: en
     - name: Français
       lang: fr
+    - name: Persian
+      lang: fa

Also note that we are no longer providing the ODT/PDF versions of the document due to the additional effort required to keep them up to date. In the future we may consider providing distributable formats as long as they can be compiled from the source.

Cheers, Paulo A. Silva

Hi @PauloASilva , I wanted to let you know that the updates and revisions you requested in this part have been completed and committed. Please feel free to review them, and let me know if any further adjustments are needed.

Also, is there anything else I should consider adding or refining in the Mkdocs.yml file, particularly related to content structure or editing configurations? For example, should I include something like this for additional markdown support:

markdown_extensions:
  - footnotes

Best regards,

[This-is-Neo]

Hi @This-is-Neo, Carefully review my comments: some requested changes apply to all translation sources.

Please compare you sources with the original ones in terms of structure e.g. headings, unnecessary ---, use of markup instead of markdown when not required, ...

Take your time to carefully review the translation source making sure it follows the original EN source as much as possible. Keep in mind that reviews like this one require a lot of time and effort from all of us.

Cheers, Paulo A. Silva

Hi @This-is-Neo, Carefully review my comments: some requested changes apply to all translation sources.

Please compare you sources with the original ones in terms of structure e.g. headings, unnecessary ---, use of markup instead of markdown when not required, ...

Take your time to carefully review the translation source making sure it follows the original EN source as much as possible. Keep in mind that reviews like this one require a lot of time and effort from all of us.

Cheers, Paulo A. Silva

Hi @PauloASilva ,

I have completed the revisions as requested. Below is a summary of the updates I made:

• Corrected the links for consistency and accuracy.
• Updated the mkdocs.yml file to ensure proper structure and navigation.
• Removed the index.md file as it is no longer required.
• Edited 0x00-header.md to exactly match the original reference in this link. The original reason I had changed it earlier was due to differences between the Mkdocs server output and the GitHub display, but I have reverted it to the original for consistency.
• Removed all
  tags to align with the Markdown structure used in the English version.
• Eliminated all inline markups that were not necessary.
• Corrected the heading levels throughout the document to ensure proper hierarchy and readability.
• Removed any unnecessary empty lines and standardized the use of headings (#) without alternate syntax.
• Moved all URLs to the bottom of the source file, as per the original English source for cleaner and more organized code.

These changes should now make the document fully aligned with the original English source and address all of your previous comments. Please feel free to review and let me know if any further adjustments are needed.

Best regards,

[PauloASilva]

These changes should now make the document fully aligned with the original English source and address all of your previous comments. Please feel free to review and let me know if any further adjustments are needed.

Unfortunately, they don't: build process is broken I guess due to editions/2023/mkdocs.yml changes.

I may take a while to put this together so that it can be merged.

Cheers, Paulo A. Silva