Docs, Starcraft 2: Add French documentation for setup and game page #3031

neocerber · 2024-03-26T02:02:11Z

What is this fixing or adding?

Add a French version of the setup and game page for Starcraft 2.
- Except for the "Progression Balancing" section, the content of the French setup/game page should be a direct translation of its English counter-part.
Adapt the Starcraft 2 ?world class? for multiple tutorials.
Add a link to the French game page in the English game page to make potential French user aware that it exist (Without that, the French game page is only available by changing the url by hand.)
Corrected the English game page first header (Starcraft 2 is no longer limited to Wing of Liberty) and a sentence.

How was this tested?

By locally hosting the website, the rendering of the French setup and game page was confirmed. It was also confirmed that the English setup and game page remains correctly rendered. All the url and link of the French setup and game page were confirmed to redirect at the correct page/location.

If this makes graphical changes, please attach screenshots.

None that are relevant.

… introduction of the game in french

…age. Re-read and corrected both the game page and setup page.

Ziktofel · 2024-03-27T17:56:21Z

I don't speak French but the French manual appears to have all the sections as the English one does.

benny-dreamly

overall looks pretty good I gave up suggesting things as it's too early for my French brain to function. I only looked at specifically the setup guide and such (I don't play Starcraft so I can't give feedback on the specifics but overall it looks fairly good)

worlds/sc2/docs/setup_fr.md

worlds/sc2/docs/setup_en.md

…nsistency.

neocerber · 2024-03-29T00:56:56Z

Thank you benny-dreamly for the comments! I applied some of them but I would require your input on those kept open.

neocerber · 2024-03-29T16:20:17Z

All benny-dreamly suggestions/comments/changes were resolved.

agilbert1412

Found a few typos, had a few suggestions which I am not particularly attached to, feel free to ignore

I did not review the MacOS guide

worlds/sc2/docs/fr_Starcraft 2.md

worlds/sc2/docs/setup_fr.md

agilbert1412 · 2024-03-29T17:29:48Z

worlds/sc2/docs/setup_fr.md

+veuilliez consutler [*Creating a YAML*](/tutorial/Archipelago/setup/en#creating-a-yaml).
+
+### Questions récurrentes à propos du fichier yaml
+#### Comment est-ce que je sais que mon *yaml* est bien défini?


Rien sur le fait de le tester sur le site? il y a même une page exprès pour https://archipelago.gg/check

TIL! I didn't it even existed!

The paragraph was changed to add this information, both in the French and English documentation. Could you validate it is ok?

I'll take a look!

worlds/sc2/docs/setup_fr.md

agilbert1412 · 2024-03-29T17:33:36Z

worlds/sc2/docs/setup_fr.md

+#### Comment est-ce que je fais pour connaître le nom des *items* dans *StarCraft 2 Archipelago*? 
+
+Vous trouverez la liste complète des *items* de *StarCraft 2 Archipelago* à la page 
+[*Icon Repository*](https://matthewmarinets.github.io/ap_sc2_icons/).


pas de mention du data package?

Hmm, well, I have do idea what that is and it is note in the English version. Do you have a ref? I will read on it and incorporate the info., if I can, in both language.

I find it cool that Starcraft 2 has a dedicated page for it at this address, but if that page ever goes down, the users will be left with nothing.
Archipelago offers http://archipelago.gg/datapackage
It shows every exact name, for every item and location, for every game. It's not as cute, but if the documentation is currently working, that means the website is up, so the datapackage is working as well. Would be cool to mention it in addition to the cute one, as a "backup", I think

Data package was mentioned. Since it also provides locations names, changed the title to include location. Since location is in the title, a mention that they are easy to find in the client was also made.

This was done in the French and English documention for uniformity.

Bicoloursnake

I can't read French, but the correction to my sloppy macOS section on the English doc is appreciated. The tutorial object appears to be constructed correctly as well, though I'm away from my machine where I'd normally test to confirm that everything loads correctly on the webhost.

…ection/suggestions

neocerber · 2024-03-30T15:11:26Z

Thank you @agilbert1412 for the comments! I applied most of them but I would like your input on those kept open.

agilbert1412

Still a few comments of mine left open, but they are all so minor that I feel like I can approve this.

worlds/sc2/docs/fr_Starcraft 2.md

… random writing (fr), applied some suggestons in writing quality(fr), added a mention to the datapackage (fr/en), enhanced prog balancing recommendation (fr)

neocerber · 2024-03-31T03:36:17Z

All the suggestions of agilbert1412 were considered. I left two of them unresolved since they required larger changes that might be of interest to review again. However, agilbert1412 has already indicated that the current version seems acceptable.

Some other changes, that were not requested, were made:

Changed all Starcraft to StarCraft for uniformity.
Changed all link to Archipelago own pages to relative link so that it works even when self-hosting.
- I validated all the link after the changes.
Information about the datapackage was also added in the English part for uniformity with the proposed French documentation.

MatthewMarinets

Only reviewed the English parts, and I have not yet run the Webhost locally to verify the links to french pages show up. I noticed some minor grammatical issues in the English docs, but otherwise looks solid.

worlds/sc2/docs/setup_en.md

neocerber · 2024-03-31T19:46:28Z

The suggestions of MatthewMarinets are all resolved.

benny-dreamly

forgot to approve this will do that now

neocerber · 2024-04-03T22:03:37Z

Need to add a mention that the mod/game might break if not setted to english

…d mention to hotkey and language restriction

neocerber · 2024-04-13T02:01:43Z

Added a mention that the mod/game might break if not setted to english
- "Notez que votre jeu StarCraft 2 (...)"
Added instruction for custom hotkey
- "Mon profil de raccourcis clavier n'est (...)"
Removed correction of game name in english part since proposed in SC2 Documentation: Fix the page titles #3074

Bicoloursnake · 2024-04-13T02:46:43Z

The English part still looks good after the recent commits.

Bicoloursnake · 2024-05-08T00:35:25Z

I tested locally and can confirm that the relative links work as expected, and that the French documentation is accessible as expected (I still can't read most of the French to comment on that though).

Thelk641

Overall, it all sounds fine to me. One paragraph feels very robotics, but the rest is okay for me as a native French speaker from the old world.

worlds/sc2/docs/setup_fr.md

neocerber · 2024-05-26T18:26:25Z

All suggestions were processed. Every part of the French and English modifications were checked at least once. The validity of the links were tested by both the author and a peer.

…rchipelagoMW#3031) * Started to create the french doc * First version of sc2 setup in french finish, created the file for the introduction of the game in french * French-fy upgrade in setup, continue translation of game description * Finish writing FR game page, added a link to it on the english game page. Re-read and corrected both the game page and setup page. * Corrected a sentence in the SC2 English setup guide. * Applied 120 carac limits for french part, applied modification for consistency. * Added reference to website yaml checker, applied several wording correction/suggestions * Modified link to AP page to be in relative (fr/en), uniformed SC2 and random writing (fr), applied some suggestons in writing quality(fr), added a mention to the datapackage (fr/en), enhanced prog balancing recommendation (fr) * Correction of some grammar issues * Removed name correction for english part since done in other PR; added mention to hotkey and language restriction * Applied suggestions of peer review * Applied mofications proposed by reviewer about the external website --------- Co-authored-by: neocerber <[email protected]>

neocerber added 5 commits March 23, 2024 15:58

Started to create the french doc

e1a9a56

First version of sc2 setup in french finish, created the file for the…

4af956c

… introduction of the game in french

French-fy upgrade in setup, continue translation of game description

b32d200

Finish writing FR game page, added a link to it on the english game p…

d5d52aa

…age. Re-read and corrected both the game page and setup page.

Corrected a sentence in the SC2 English setup guide.

de5b3ae

github-actions bot added the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label Mar 26, 2024

alwaysintreble added is: documentation Improvements or additions to documentation. is: enhancement Issues requesting new features or pull requests implementing new features. labels Mar 28, 2024

benny-dreamly reviewed Mar 28, 2024

View reviewed changes

Applied 120 carac limits for french part, applied modification for co…

3b7f023

…nsistency.

agilbert1412 suggested changes Mar 29, 2024

View reviewed changes

Bicoloursnake approved these changes Mar 29, 2024

View reviewed changes

Added reference to website yaml checker, applied several wording corr…

982b0fb

…ection/suggestions

agilbert1412 approved these changes Mar 30, 2024

View reviewed changes

worlds/sc2/docs/fr_Starcraft 2.md Outdated Show resolved Hide resolved

Modified link to AP page to be in relative (fr/en), uniformed SC2 and…

a3088ab

… random writing (fr), applied some suggestons in writing quality(fr), added a mention to the datapackage (fr/en), enhanced prog balancing recommendation (fr)

MatthewMarinets approved these changes Mar 31, 2024

View reviewed changes

worlds/sc2/docs/setup_en.md Outdated Show resolved Hide resolved

worlds/sc2/docs/setup_en.md Outdated Show resolved Hide resolved

neocerber mentioned this pull request Mar 31, 2024

Docs: Français Setup Guide Support #2302

Open

53 tasks

Correction of some grammar issues

e53e023

benny-dreamly approved these changes Mar 31, 2024

View reviewed changes

MaxTousss mentioned this pull request Apr 1, 2024

SC2 Documentation: Fix the page titles #3074

Merged

neocerber mentioned this pull request Apr 11, 2024

Docs: add Translate FR guide for Bk Sudoku #3111

Closed

Removed name correction for english part since done in other PR; adde…

ad9c56a

…d mention to hotkey and language restriction

neocerber mentioned this pull request May 2, 2024

Aquaria: implement new game #3197

Merged

Thelk641 reviewed May 17, 2024

View reviewed changes

neocerber and others added 2 commits May 17, 2024 09:10

Applied suggestions of peer review

c43a3b6

Applied mofications proposed by reviewer about the external website

ba5b0a6

neocerber force-pushed the feature/SC2-frenchDocumentation branch from 59bc5f0 to ba5b0a6 Compare May 26, 2024 18:15

Merge branch 'main' into feature/SC2-frenchDocumentation

954cbbb

Ziktofel added waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. and removed waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels May 26, 2024

NewSoupVi approved these changes May 29, 2024

View reviewed changes

NewSoupVi merged commit 5275593 into ArchipelagoMW:main May 29, 2024
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs, Starcraft 2: Add French documentation for setup and game page #3031

Docs, Starcraft 2: Add French documentation for setup and game page #3031

neocerber commented Mar 26, 2024

Ziktofel commented Mar 27, 2024

benny-dreamly left a comment

neocerber commented Mar 29, 2024

neocerber commented Mar 29, 2024

agilbert1412 left a comment

agilbert1412 Mar 29, 2024

neocerber Mar 30, 2024 •

edited

Loading

agilbert1412 Mar 30, 2024

agilbert1412 Mar 29, 2024

neocerber Mar 30, 2024

agilbert1412 Mar 30, 2024

neocerber Mar 31, 2024

Bicoloursnake left a comment

neocerber commented Mar 30, 2024 •

edited

Loading

agilbert1412 left a comment

neocerber commented Mar 31, 2024 •

edited

Loading

MatthewMarinets left a comment

neocerber commented Mar 31, 2024

benny-dreamly left a comment

neocerber commented Apr 3, 2024 •

edited

Loading

neocerber commented Apr 13, 2024 •

edited

Loading

Bicoloursnake commented Apr 13, 2024 •

edited

Loading

Bicoloursnake commented May 8, 2024 •

edited

Loading

Thelk641 left a comment

neocerber commented May 26, 2024

Docs, Starcraft 2: Add French documentation for setup and game page #3031

Docs, Starcraft 2: Add French documentation for setup and game page #3031

Conversation

neocerber commented Mar 26, 2024

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

Ziktofel commented Mar 27, 2024

benny-dreamly left a comment

Choose a reason for hiding this comment

neocerber commented Mar 29, 2024

neocerber commented Mar 29, 2024

agilbert1412 left a comment

Choose a reason for hiding this comment

agilbert1412 Mar 29, 2024

Choose a reason for hiding this comment

neocerber Mar 30, 2024 • edited Loading

Choose a reason for hiding this comment

agilbert1412 Mar 30, 2024

Choose a reason for hiding this comment

agilbert1412 Mar 29, 2024

Choose a reason for hiding this comment

neocerber Mar 30, 2024

Choose a reason for hiding this comment

agilbert1412 Mar 30, 2024

Choose a reason for hiding this comment

neocerber Mar 31, 2024

Choose a reason for hiding this comment

Bicoloursnake left a comment

Choose a reason for hiding this comment

neocerber commented Mar 30, 2024 • edited Loading

agilbert1412 left a comment

Choose a reason for hiding this comment

neocerber commented Mar 31, 2024 • edited Loading

MatthewMarinets left a comment

Choose a reason for hiding this comment

neocerber commented Mar 31, 2024

benny-dreamly left a comment

Choose a reason for hiding this comment

neocerber commented Apr 3, 2024 • edited Loading

neocerber commented Apr 13, 2024 • edited Loading

Bicoloursnake commented Apr 13, 2024 • edited Loading

Bicoloursnake commented May 8, 2024 • edited Loading

Thelk641 left a comment

Choose a reason for hiding this comment

neocerber commented May 26, 2024

neocerber Mar 30, 2024 •

edited

Loading

neocerber commented Mar 30, 2024 •

edited

Loading

neocerber commented Mar 31, 2024 •

edited

Loading

neocerber commented Apr 3, 2024 •

edited

Loading

neocerber commented Apr 13, 2024 •

edited

Loading

Bicoloursnake commented Apr 13, 2024 •

edited

Loading

Bicoloursnake commented May 8, 2024 •

edited

Loading