Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mise à jour des instructions d'installation pour macOS. #6427

Conversation

AmauryCarrade
Copy link
Member

@AmauryCarrade AmauryCarrade commented Nov 30, 2022

Mise à jour majeure de la documentation d'installation sous macOS 12+.

Cette mise à jour comprend :

  • des recommandations sur l'installation de ZdS sous macOS (notamment, l'utilisation des GNU Coreutils à la place de ceux de BSD) ;
  • la mise à jour de la documentation pour indiquer les commandes modernes du Makefile ;
  • une réécriture entière de la documentation pour macOS afin qu'elle soit plus didactique.

Contrôle qualité

  • Relire la documentation à la recherche de typos (le correcteur ortho-grammatical de PyCharm me dit que c'est bon, mais sait-on jamais).
  • Idéalement, tester l'installation en suivant ces instructions sous macOS 12+.

Le commit n'est pas signé car je n'ai pas encore reconfiguré la signature automatique de mes commits sur mon nouvel ordi — sous macOS, vous l'aurez deviné. Ayant configuré GitHub pour exiger la signature de mes commits, c'est normal qu'il râle. C'est bien moi :p .

@AmauryCarrade AmauryCarrade added S-BUG Corrige un problème C-Docs Concerne la documentation S-Refactorisation Améliore le code existant sans forcément ajouter de nouvelle fonctionnalité labels Nov 30, 2022
@AmauryCarrade AmauryCarrade changed the title [doc] Mise à jour des instructions d'installation pour macOS. Mise à jour des instructions d'installation pour macOS. Nov 30, 2022
@coveralls
Copy link

coveralls commented Nov 30, 2022

Coverage Status

Coverage: 88.302%. Remained the same when pulling e0b3d6a on AmauryCarrade:docs/macos-ventura--les-evolutionnistes-ont-aussi-droit-dinstaller-zds into 10a72ac on zestedesavoir:dev.

Copy link
Member

@philippemilink philippemilink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Belle documentation !

Peut-être un peu trop détaillée par endroits, mais je ne vais pas te faire retirer des phrases :)

Je suis étonné que tu ais eu besoin d'installer les coreutils GNU/Linux. Sur mon Mac bloqué à la version BigSur 11.6, je ne me souviens pas précisément comment j'avais installé initialement ZdS, mais je n'avais pas eu besoin de faire ces manipulations...

Quelques typos, problèmes de formatage et reformulations suggérées et on pourra merger.

doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
doc/source/install/install-osx.rst Outdated Show resolved Hide resolved
@AmauryCarrade
Copy link
Member Author

C'est OK pour moi, j'ai repris toutes les remarques, corrigé les apostrophes, renommé le fichier afin d'être cohérent avec le nouveau nom de macOS, et voilà !

@AmauryCarrade
Copy link
Member Author

AmauryCarrade commented Dec 25, 2022

J'avais pas vu certains commentaires de @philippemilink.

Peut-être un peu trop détaillée par endroits, mais je ne vais pas te faire retirer des phrases :)

J'ai voulu rendre la documentation accessible y compris à des débutant·es complets, afin de faciliter la contribution. C'est pour ça que la documentation s'apparente presque à un tutoriel à certains endroits. C'est aussi pour ça que j'ai pensé à deux niveaux de lecture, en écrivant un chemin de contournement.

Je suis étonné que tu ais eu besoin d'installer les coreutils GNU/Linux. Sur mon Mac bloqué à la version BigSur 11.6, je ne me souviens pas précisément comment j'avais installé initialement ZdS, mais je n'avais pas eu besoin de faire ces manipulations...

C'est probablement faisable en contournant le script d'installation et en faisant les étapes à la main (comme la CI), ou en réécrivant le script pour qu'il soit aussi compatible avec BSD/Darwin. J'ai fait ce choix afin de continuer d'utiliser le script d'installation, et donc d'être futur-proof, évitant que la documentation pour macOS ne se décale par manque de mise à jour.

On peut faire autrement, donc, mais c'est plus d'effort.

@AmauryCarrade AmauryCarrade force-pushed the docs/macos-ventura--les-evolutionnistes-ont-aussi-droit-dinstaller-zds branch from 5f903ab to 2d28e0f Compare December 26, 2022 16:44
Copy link
Member

@philippemilink philippemilink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je n'ai pas testé (j'ai déjà ZdS installé sur mon Mac), mais ça me semble correct. QA OK ✔️

@philippemilink philippemilink enabled auto-merge (squash) January 21, 2023 15:54
@philippemilink philippemilink merged commit fe00164 into zestedesavoir:dev Jan 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs Concerne la documentation S-BUG Corrige un problème S-Refactorisation Améliore le code existant sans forcément ajouter de nouvelle fonctionnalité
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants