stephane-klein / backlog Goto Github PK

Après lecture du thread et l'article Docker is dead? Podman – an alternative tool?, j'ai envie de tester Podman pendant quelques jours, sous Linux, dans un contexte station de travail :

• tester si cela fonctionne bien par rapport à Docker
• tester si cela casse certain workflow par rapport à Docker
• tester si j'ai des régressions par rapport à Docker
• tester si j'ai des améliorations, des avantages au quotidien par rapport à Docker

Le but de cette issue n'est pas de tester Podman en mode déploiement (hébergement).

Voir aussi : #13

Après lecture du thread et l'article Docker is dead? Podman – an alternative tool?, j'ai envie de tester le projet https://github.com/lima-vm/lima sous MacOSX et comparer cette solution avec Docker Desktop.

Ce qui me fait un peu peur, c'est de casser mon installation courante de Docker Desktop 🤔

Je cherche une solution pour générer un document markdown à partir d'une configuration react-router

Exemple, j'ai ce code :

                        <Route
                            path='/logout/'
                            component={Logout}
                        />

                        <Route
                            exact
                            strict
                            path='/profile/'
                            component={Profile}
                        />

il génère ce document Markdown :

- `/logout/`
- `/profile/`

Hi Stéphane,

I am curious about your opinion on Pieter Hintjens' C4?
The document is explained in one of Hintjens' books.
Nextcloud thought about using C4, there is an insightful discussion about it on their related issue.

Mettre à jour https://github.com/stephane-klein/svelte-ssg-postcss-poc avec la dernière version de Svelte + migrer vers pnpm.

Todo :

• Upgrade vers dernière version de Svelte
• Migrer vers pnpm

Le nom de ce repository personnal-notebook n'est plus du tout adapté à l'usage que je fais ce de repo.

J'aimerais renommer ce repo. Voici les quelques idées :

• basecamp
• backlog
• home
• project-management

J'aimerais extraire les articles vers :

• stephane-klein.info
• ou sklein.xyz

Écrire un article pour décrire quelque serait ma stack en août 2022 pour développer une app web dans un environnement greenfield.

Ressources :

• en mode aventurier : Svelte Kit en SSR + Hydrate + Postgres
• en mode un peu plus conservateur : ite-plugin-ssr + Hydration + React + PostgreSQL (#38)

En août 2021, j'ai commencé à utiliser Dotdrop pour gérer mes "dotfiles" sous GNU/Linux et macOS.

1 an plus tard, je ne suis toujours pas satisfait de la syntax de Dotdrop, je dois à chaque fois consulter la documentation pour comprendre par exemple dans quel sens sont effectués les opérations… Je n'ai pas noté la liste de mes problèmes, par conséquent, je recherche, je ne suis pas en mesure de donner plus de détail ici.

Suite à la lecture de Your unofficial guide to dotfiles on GitHub, le subreddit dotfiles, le topic GitHub "yadm" (228 entries), le topic GitHub "dotdrop" (21 entries)… j'ai envie de tester :

• yadm
• chezmoi

Todo :

• Lire Chezmoi - Comparison table
• Décider quel outil tester en premier
• Commencer par tester chezmoi
• Lire Chezmoi - Use scripts to perform actions

J'aimerais tester https://github.com/tubearchivist/tubearchivist

Todo :

• Regarder https://www.youtube.com/watch?v=O8H8Z01c0Ys
• Créer un repo https://github.com/stephane-klein/tubearchivist-hosting-playground
• ...

Rassembler des articles à propos des wording UI suivant :

• zoning
• mock-up
• prototype
• wireframe

Ressources :

• The difference between mock-up, prototype and wireframe
• Quelle est la différence entre le Zoning, Wireframe, Mockup et Prototype ?

Les définitions semblent varier.

Articel Wikipedia :

• Website wireframe
  • L'article parle de High-fidelity wireframe, Low-fidelety wireframe

Cela fait des années que je me dis en allant sur MetroFrance : j'aimerais bien pouvoir consulter:

• la météo qui a vraiment eu lieu dans le passé
• et comparer les prévisions à la réalité

Pour le moment je n'ai jamais trouvé ces fonctionnalités, à noter que je n'ai pas beaucoup cherché.

But de cette issue : essayer de trouver un service qui propose cela.

Lors de la rédaction de spécifications produit ou logiciel compliqué, la rédaction direct dans une issue GitHub ou GitLab n'est pas très pratique.

Si l'expression du besoin ou la proposition d'implémentation est compliqué, alors :

• le travail de rédaction peut être fait sur une longue période
• l'artefact aura de très grandes chances d'avoir plusieurs versions
• l'artefact devra sans doute être review, avec des échanges autour des feedbacks effectués lors de la review par des pairs
• ...

D'autre part, ce document sera sûrement utile dans le temps, pour comprendre les différents choix d'implémentation qui étaient possibles et les arbitrages effectués.

Toutes ces caractéristiques me font penser à une chose : les RFC dans le monde internet et open source.

Voici une liste de communauté qui utilise le concept de RFC :

• Python : PEP
• php : RFC
• Golang : Proposing Changes to Go
• Kubernetes : Enhancements tracking repo for Kubernetes
• Rust : RFCs for changes to Rust
• Ember : RFCs for changes to Ember

Note : j'ai le sentiment que les communautés qui ont un système de "RFC" sont celles qui avancent le mieux, qui sont les plus "mature".
Je précise que les tout petits projets n'ont pas besoin de cela, souvent ce sont des projets conduit par une seule personne.

Le but de cette issue est d'étudier les différents workflow de rédaction, validation de ces RFCs et d'essayer de définir un process qui pourrait fonctionner en inner-source à l'intérieur d'une company tech.

Autre concept commun : Special Interest Group

En rédigeant cette issue, je suis tombé sur Best current practice que je ne connaissais pas et qui me semble intéressant.

Todo :

• Lire Scaling Engineering Teams via RFCs: Writing Things Down
• Lire et creuser https://en.wikipedia.org/wiki/Special_interest_group
• Lire et creuser Best current practice
• Lire Design Docs at Google
• Lire Architecture decision record (ADR)
• Lire https://en.wikipedia.org/wiki/Architectural_decision
• Lire https://adr.github.io/
• Étudier les cycles de vie des "RFC" suivants :
  • Python - PEP 1 – PEP Purpose and Guidelines
    • Analyser https://discuss.python.org/c/peps/19
  • Php - How To Create an RFC
  • Proposing Changes to Go
  • Rust : https://github.com/rust-lang/rfcs
  • Kubernetes : Is My Thing an Enhancement?
• Lire : https://github.com/artsy/README#request-for-comments

Chercher une solution (extension Firefox/Chrome) pour désactiver dans GitHub, GitLab, Discourse le picker qui s'affiche automatiquement après la saisie de :, exemple :

En typographie Française, « le deux-points habituel est séparé du caractère qui le précède par une espace insécable », ce qui n'est pas le cas en anglais.
Conséquence : ce fonctionnement est pénible lors de la rédaction en français, parce que l'insertion d'emoji est généralement pas souhaité et la fermeture du picker est une action pénible.

Todo

• Chercher sur GitHub si je trouve une extension Firefox/Chrome
• Chercher dans le Firefox extension store si je trouve quelque chose
• Chercher sur Reddit
• Si aucune solution trouvée, poser la question dans un subreditt
• Créer et publier un userstyle
• Tester le userstyle sous Chrome
• ...

Trouver où créer un site qui permet d'afficher les taux de rendement par an et sur une période, de différents supports d'investissement.

Liste d'exemple de type d'investissement :

• bien immobilier à Paris (T1, T2, ... par arrondissement)
• CAC40
• Obligation en €
• Apple
• NASDAQ 100
• crypto
• ...

Todo :

• rédiger une explication explicite de ce que je cherche
• demander à Reddit Vosfiance ce qu'il existe

J'aimerais ajouter le support SQL et PL/pgSQL à l'outil difftastic.

Au cours de ces dernières années, j'ai été de nombres fois confronté à la problématique suivante :

• un service nommé foobar est actuellement en production
• un refactoring from scratch du service foobar est commencé
• une instance du refactoring de foobar est déployé sur les instances develop, staging ou même production (caché) en parallèle du service foobar

Problème : comment nommer le refactoring de "foobar" ?

Précisions :

• il se peut que le refactoring de foobar ne soit jamais mis en production, abandonné ou remplacé par un autre refactoring
• foobar n'a pas de numéro de version, je suis en mode rolling release, le service est versionné dans un dépôt Git, le sha1 git permet d'identifier la version d'un instance (prod, dev, staging…)

Mes échecs de naming :

1. future-foobar
2. foobar-v2

Semi échec de naming :

3. foobar-summer-2019, -summer-2019 est le moment où le refactoring a commencé

Où sont utilisés/présent le nom des services ?

• dans des discussions à l'intérieur d'équipes et même entre membres d'équipes différentes
• dans des noms de dossiers, exemple :
  • /services/foobar/
  • /services/future-foobar/
• dans des urls, examples :
  • https://foobar.staging.example.com
  • https://future-foobar.staging.example.com
• dans des noms d'images Docker, examples :
  • docker.example.com/services/foobar:develop
  • docker.example.com/services/future-foobar:develop
• au niveau de label GitLab
• au niveau de titre d'issues
• au niveau de noms de services docker-compose.yml, example :

   foobar:
       image: docker.example.com/services/foobar:develop
       ...
  
   future-foobar:
      image: docker.example.com/services/future-foobar:develop
      ...
  

• au niveau de projet Sentry
• au niveau de tag Prometheus, Grafana
• ...

Problèmes rencontrés

Problème de swap de nom

Le swap de nom arrive dans les cas suivants.

Au moment t j'ai les instances suivantes déployés sur prod :

• foobar
• future-foobar

Si a t+1 il est décidé de couper le service foobar alors, je rencontre des problèmes de déploiement et de renomming dans Git… :

• Niveau infra as code, je ne peux pas simplement supprimer foobar, je dois dans le même commit, le même terrafrom apply ou ansible-playbook exécuter :
  • 1 suppression de foobar
  • 2 stop future-foobar
  • 3 rename future-foobar vers foobar
  • 4 restart foobar
• Tout ceci a des incidences sur les dépendances : fichier de conf, url, Sentry, Prometheus…
• À cause de ce renomming, il n'est pas possible de déployer sans longue coupure de service

Problème du naming -v2, -v3...

Ce naming me pose les problèmes suivants :

• crée de la confusion pour un projet qui est en rolling release
• autre confusion si foobar-v3 est mis en production sans jamais aucune mise en production de foobar-v2

Propositions

• proposition 1 : utiliser un nom de code, comme par exemple
  • mozilla pour le refactoring de Mosaic
  • Longhorn pour un refactoring de MS Windows
  • Rhapsody refactoring de MacOS
    Idée de nom : utiliser dans l'ordre les adjectifs : https://github.com/moby/moby/blob/06ca1606e1a09c36bd12ed503b4c99d8a17ca230/pkg/namesgenerator/names-generator.go#L9
• proposition 2 : Au niveau des dossiers, image docker… utiliser un random number de 4 caractères, example : foobar-4e4a

Test KitDocs qui est basé sur SvelteKit.

Mes tests sont effectués dans : https://github.com/stephane-klein/kit-docs-playground

Todo :

• Tester le support du placement des ressources markdown dans un dossier parent (mono repo)
• Tester le support de TOC sur des pages markdown
• Tester le support page précédente / suivante
• Tester le support i18n, idéalement cette structure d'organisation de fichiers

  /docs/page1.md
  /docs/page1.fr.md
  ...
  

• Tester l'intégration d'un moteur de recherche static (du style Lunrjs ou Stork (qui semble plus moderne))
• Tester la possibilité d'implémenter des pages en SSR

Rédiger et publier sous une page Garden, mon "README management".

Idée de contenu :

• comment j'utilise les réactions 👀✅... et pourquoi
• comment communiquer avec moi…
• ...

Essayer de partir sur une base minimaliste, publier et itérer dessus, sinon, je ne publierai jamais cette page.

Todo :

• Dresser une liste de management readme disponible sur le net

Écrire un article à propos de : « Est-ce que la difficulté de la gestion de projet est l'outil ou la capacité à écrire des issues / Epic ? »

Je souhaite estimer à partir de combien d'années de remboursement un investissement immobilier est rentable à partir des paramètres suivants :

• prix du bien
• apport
• taux d'emprunt
• durée d'emprunt
• prix des travaux
• estimation prix de revente
• comparaison avec le coût d'un logement du même type

À lire :

• https://old.reddit.com/r/vosfinances/comments/sh2jnz/calcul_location_vs_achat_quelle_est_la_logique/

Suite à ce bug https://github.com/svelteness/kit-docs/issues/49 j'essaie de faire fonctionner l'import d'une icône :

import MoonClearFill from '~icons/ri/moon-clear-fill';

pour le moment, j'ai l'impression que cette icône est fournie par unplugin-icons mais je n'en suis pas certain et je ne comprends pas trop la relation de ce package avec @iconify-json/ri.

Je souhaite contribuer à cette issue https://github.com/svelteness/kit-docs/issues/50#issuecomment-1179697629 mais pour cela, je dois comprendre comment fonctionne :

$ npm init @svelteness/kit-docs mydocs

Todo :

• Lire https://www.npmjs.com/package/npx
• Lire et tester https://docs.npmjs.com/cli/v8/commands/npm-exec
• ...

Dans la vidéo Introduction - Définir le mérite ? Analyse sémantique et conceptuelle (#42) il conseille le livre Les Français face aux inégalités et à la justice sociale (Hors Collection).

Todo :

• Ajouter lien vers le modèle
• Poster la spec matériel complète
• Tester la webcam
• Chercher des riews sur https://old.reddit.com/r/thinkpad/
• Chercher sur le wiki du reddit Thinkpad : https://old.reddit.com/r/thinkpad/wiki/index
• Si j'arrive à rassembler des notes de qualités alors
  • Traduire en Anglais
  • Poster sur https://old.reddit.com/r/thinkpad/
  • ...

Note :

• Le qualité du son est vraiment pourri, catastrophique
• Le unlock par fingerprint fonctionne très bien
• Le clavier est bien
• Il est plutôt léger
• L'écran 16/9 est trop fin à mon goût, je préfère un 16/10 (voir #40)

J'aimerais réaliser un site qui affiche toutes les annonces immobilières de moins de 50K€ à 2h de Paris sur une carte.

• Étudier ce qu'il existe déjà dans l'écosystème Français
• Étudier ce qu'il existe dans l'écosystème USA

Scrapping de :

• leboncoin
• seloger
• Afficher des POI
• Afficher pluviométrie
• Temps de transport
• ...

Faire une vidéo YouTube qui explique en Français comment installer Homebrew

Chercher si ce type de vidéo existe déjà.

Je souhaite faire un POC de https://github.com/adjust/clickhouse_fdw

Todo :

• Builder ce Foreign Data Wrapper extension dans une image Docker
• Tester l'insertion en masse de données vers une table ClickHouse depuis Postgres
• Tester de faire un select sur la table ClickHouse avec une fonction d'agrégation, depuis Postgres
• Tester de faire un select sur la table ClickHouse + une jointure vers une table Postgres
• Insérer la même quantité de données dans une table Postgres
• Benchmarker la différence de vitesse entre l'agrégation Postgres et Clickhouse

En lisant ce Thread Reddit What do you do with an engineer that won't read the documentation?, je repense à une idée de fonctionnalité de documentation. Je souhaite la décrire dans cette issue.

Une organisation humaine qui est "Documentation centric", qui essaie de suivre une méthode stigmergie, produit beaucoup de documentation, qui peuvent être plus ou moins mise à jour fréquemment.

Par exemple :

• j'aime beaucoup Le guide de la communauté beta.gouv
• le très réputé Handbook de GitLab (avec ses milliers de pages 🙈)
• ...

Constats :

• en phase d'onboarding, la taille de cette base documentaire peut être déroutante. La personne qui arrive dans une organisation, reçoit énormément "d'input" pendant ses premiers jours.
  
  Si cette personne suis linéairement la documentation, beaucoup d'information ne vont pas lui sembler pertinentes, ce qui est normal, parce qu'au moment de la lecture, il lui manque d'autres connaissances (des dépendances), le contexte.
  
  Conséquence : la personne "zappe" ces informations, des petits paragraphes, qui lui seront utiles par la suite, peut être dans deux semaines, dans un mois…
• après une plus longue durée dans l'organisation, il peut être difficile pour une personne de suivre ce qui a changé, dans les documentations de process. La personne ne sait pas ce qu'elle a lu ou pas lu.
• il est très difficile de savoir quel est le niveau de lecture d'une doc, quel est par exemple le niveau de diffusion d'un paragraphe, est-ce que seulement 5% des personnes l'ont lu ? ou 80% ? Cette information peut être utile quand un collègue a besoin de l'aide. Par exemple, ça ne sert à rien de lui demander de relire la documentation si elle l'a déjà lu… peut-être que la documentation n'est pas compréhensible. Inversement, si la documentation n'a pas été lu, peut-être qu'elle est difficile à trouver.

Pratique que j'aime suivre :

• j'apprends beaucoup de chose en lisant les commentaires sur HackerNews, Reddit, LinuxFR…

  • Sur https://linuxfr.org, j'aime beaucoup la fonctionnalité qui m'indique le nombre et la liste des nouveaux commentaires depuis ma dernière visite
  • Pour HackNews, j'utilise l'extension https://github.com/etcet/HNES/ qui me permet de « Show and highlight new comments since you last view a thread »
  • Pour Reddit, j'utilise https://redditenhancementsuite.com/features/ qui me permet aussi de lister les nouveaux commentaires depuis ma dernière visite

• Quand je travaille dans GitLab, Mattermost, Slack…, j'aime mettre un ✅ sur les messages que j'ai lu :

  • pour identifier rapidement ce que j'ai lu ou pas lu
  • pour informer mes collègues que j'ai bien pris connaissance (ou non) de leur message

Pratique non optimal :

• depuis 20 ans, je relis régulièrement la documentation de PostgreSQL, il m'arrive souvent de découvrir de nouvelles choses lors d'une nouvelle lecture. Problème : je ne sais pas ce que j'ai lu ou pas lu.

Idée de fonctionnalité

J'aimerais pouvoir ajouter la fonctionnalité suivante à des documentations (propulsé par exemple par un des outils listés dans #17) :

• pouvoir annoter au niveau de chaque paragraphe ou plus grande section (à déterminer) :
  • "j'ai lu"
  • "j'ai pas bien compris"
  • "todo à lire"
• je veux pouvoir voir sur chaque paragraphe ou plus grande section :
  • ce que j'ai lu
  • qui parmi les utilisateurs, qui a déclaré avoir lu ce paragraphe
• je veux pouvoir voir facilement tous les paragraphes qui ont été changés depuis ma dernière lecture

Idée d'implémentation :

• peut-être implémenter cela dans une extension browser + un petit serveur pour centraliser l'information
• peut-être sous forme d'une lib JS, à intégrer dans le logiciel de génération de documentation

Comment identifier ce qui a été lu / pas lu ?

• peut-être générer une "empreinte" (sha-1) ou autre du contenu du paragraphe + son url + sa position dans l'arborescience des sections 🤔
• peut-être que le générateur de documentation doit générer un uuid sur toutes les sections pour l'identifier 🤔

Clarifier : Product Manager vs Product Owner

Ressources :

• Subreddit Product Management - Product Manager vs Product Owner
• Chaine YouTube ScrumLife : Product Owner (PO) et Product Manager (PM) : quelle différence ? - Scrum Life 28
  • Peut être regarder aussi : Scrum Master VS. Product Owner
• Article Medium de Melissa Perri Product Manager vs Product Owner

  • I went on being called a Business Analyst as I worked at banks and other financial services companies. I wasn’t called a Product Manager until I bailed out of that and landed in a startup. It was all the same work I had been doing before, but now it had a different name.

  • I had not heard of the term Product Owner until years later. The first time I heard the term, I asked someone what it meant. They told me it was the same as a Product Manager, but it was a term used in Scrum.

• The History and Evolution of Product Management
  • https://twitter.com/klein_stephane/status/1315243699719241730

Peut être écrire un post Reddit à ce sujet.

On macOS, I use Preview software to merge several images or pdf documents into a single pdf document.

I look for an alternative tool on Gnome Desktop Environment.

In this branch, when I have this error:

$ pnpm run dev

> [email protected] dev /home/stephane/git/github.com/stephane-klein/kit-docs-playground/services/kit-docs
> vite dev


  vite v2.9.14 dev server running at:

  > Local: http://localhost:3000/
  > Network: use `--host` to expose

  ready in 814ms.

failed to load module for ssr: /src/lib/translations
Error: failed to load module for ssr: /src/lib/translations
    at instantiateModule (/home/stephane/git/github.com/stephane-klein/kit-docs-playground/services/kit-docs/node_modules/.pnpm/[email protected]/node_modules/vite/dist/node/chunks/dep-c9998dc6.js:50231:15)

I would like to enable the /svelteness/kit-docs/packages/kit-docs/ sourcemap files generation to find out where is the error.

I don't understand, because, I see "sourceMap": true but it seems to me that no .map are generated:

stephane@nuc-i7:~/git/github.com/stephane-klein/kit-docs-playground/svelteness/kit-docs/packages/kit-docs (4-i18n-folder-lang-extension) $ find . | grep "map"
./src/routes/sitemap.xml.js
./node_modules/.vite/deps/svelte_transition.js.map
./node_modules/.vite/deps/svelte.js.map
./node_modules/.vite/deps/clsx.js.map
./node_modules/.vite/deps/chunk-5XH2E4SI.js.map
./node_modules/.vite/deps/svelte_store.js.map
./node_modules/.vite/deps/svelte_internal.js.map
./node_modules/.vite/deps/sveltekit-i18n.js.map
./node_modules/.vite/deps/svelte_animate.js.map
./node_modules/.vite/deps/chunk-7PRYTHYU.js.map
./node_modules/.vite/deps/chunk-74GLNXRE.js.map
./node_modules/.vite/deps/shiki.js.map
./node_modules/.vite/deps/svelte_motion.js.map
./node_modules/.vite/deps/chunk-ACCAMVX6.js.map
./node_modules/.vite/deps/svelte_easing.js.map
./.svelte-kit/types/src/routes/__types/sitemap.xml.d.ts

Je souhaite lister les solutions permettant d'éditer de la documentation flatfile markdown (dans un repository Git) qui soit à la fois compatible

• "developer-centric workflow"
• et non developper centric

L'objectif : que cette solution ne casse aucun des deux workflow (chose qui me semble difficile).

Exemples d'outils :

• https://www.gitbook.com/
• ...

Suite au passage de HTTP/3 au status : PROPOSED STANDARD j'aimerais bien tester une stack HTTP/3 avec :

• Firefox
• Chrome
• nginx
• Caddy

Rédiger un article sur les méthodes de gestion de projet que je préfère.

• Estimation : agile ou pas ? 4 autres façons de se passer d'estimations
• https://twitter.com/klein_stephane/status/1248947440834797568

Je souhaite créer un repository svelte-layercake-playground, donc l'objectif sera :

• créer un graphe comme https://layercake.graphics/example-ssr/MultiLine
• mais en X, à la place de date, je souhaite des string ordonnées

I would like to study https://github.com/chakra-ui/chakra-ui/ vs https://github.com/mantinedev/mantine

I would like to test a React + ViteJS project setup, with this structure:

• services/app_a/
• services/app_b/
• services/shared/ <= lib used by app_a, app_b, and storybook
• services/storybook/
• services/end2end/ to test app_a and app_b

Contraints:

• Test with :
  • React version 17.0.2
  • React version 18.2.0
• In Javascript
• In TypeScript
• check if lazy loading is supported by Vite
• Tree shaking

See also #37

Écrire une page "garden" de liste des Subreddit que je suis et ce que j'y trouve.

• https://old.reddit.com/r/selfhosted/
• https://old.reddit.com/r/UXDesign/
• https://old.reddit.com/r/Fedora/
• https://old.reddit.com/r/linux/
• https://old.reddit.com/r/gnome/
• https://old.reddit.com/r/vosfinances/
• https://old.reddit.com/r/france/
• https://old.reddit.com/r/androidapps/
• https://old.reddit.com/r/neovim/
• https://old.reddit.com/r/sveltejs/
• https://old.reddit.com/r/ExperiencedDevs/
• https://old.reddit.com/r/onebag/
• https://old.reddit.com/r/productivity/
• https://old.reddit.com/r/programming/

J'aimerais faire un résumé en Bullet point de la vidéo https://www.youtube.com/watch?v=iNkodbHQ9jg

Ajouter un maximum de liens vers les sources, auteurs...

Écrire un article et réaliser un screencast sous YouTube qui explique comment exécuter sous MacOS un petit projet Python :

• Installer Homebrew #8
• Installer Git + Python 3 avec Brew
• Créer un virtualenv
• Installer les dépendances Python avec pip -r requirements.txt
• Lancer un script main.py

Sur ce projet GitLab : https://gitlab.com/stephane-klein/python-example-project

J'ai un serveur Baremetal, qui contient 237 container Docker avec un petit load average.

Problème : lorsque je me connecte en ssh sur ce serveur, la connexion met 9s à se faire, je me demande pourquoi 🤔

Détail du load average :

top - 09:10:11 up 75 days, 9 min,  1 user,  load average: 0.14, 0.25, 0.25
Tasks: 1130 total,   1 running, 1109 sleeping,   0 stopped,  20 zombie
%Cpu(s):  3.8 us,  4.2 sy,  0.0 ni, 92.0 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
MiB Mem :  15971.4 total,    247.2 free,  11831.2 used,   3893.0 buff/cache
MiB Swap:   4096.0 total,   1321.8 free,   2774.2 used.   3782.4 avail Mem

Spec du serveur :

• 1 × Intel® Xeon® D-1531 CPU - 6C/12T - 2.2 GHz
• 2 × 250 Go SSD
• 32 Go DDR4 ECC

Todo :

• essayer de reproduire ce problème sur une autre machine
• ...

Sphinx est peut-être le premier générateur de documentation que j'ai utilisé vers 2008.

Sphinx était (et est toujours) très bien : complet, moteur de recherche, stable, énormément d'utilisateurs dans la communauté Python...
Vers 2010, le choix était simple, il n'y avait pas de questions à se poser, étant donné que Sphinx était presque le seul et dominait totalement le "marché".

Depuis la progression spectaculaire de l'écosystème JavaScript, la donne a changé : il existe un large choix et générateurs de documentation. Le choix n'est plus simple.

Je pense que Sphinx est toujours un choix pertinent, mais Sphinx est écrit en Python et Python n'a pas la cote chez les développeurs JavaScript.

D'autre part, les générateurs de documentation, basés sur un moteur JS, permettent pour la plupart d'intégrer des Components riches (ReactJS) dans les pages, ce qui peut-être dans certaines situations très pratiques.

Concernant le dialecte Markdown, AsciiDoc, ReStructuredText, je pense que je préfère être conservateur, c'est à dire utiliser du Markdown afin que la source des pages soit correctement rendu dans GitHub ou GitLab.

Dans mes critères de comparaison, je souhaite étudier :

• la vitesse de build
• la qualité de la navigation :
  • page précédente/ suivante
  • sommaire de la page
  • sections
• qualité de la documentation de l'outil
• moteur de recherche basé sur :
  • basé sur https://lunrjs.com/
  • ou MelliSearch
• Support monorepos, c'est-à-dire, peut être setup comme ceci :

  /docs/... <= les fichiers de documentation (.md) sont placés ici
  /services/document-engine/... <= Docusaurus, docz, Vitepress, Nextra… doivent être installé ici
  

• Support i18n du type suivant :

  /docs/page1.en.md
  /docs/page1.fr.md
  /docs/page2.en.md
  /docs/page3.fr.md
  /docs/page4.en.md
  /docs/page5.fr.md
  ...
  

Je ne souhaite plus essayer de configurer le générateur de doc sur la structure de fichiers des README.md d'un monorepo.
J'ai perdu trop de temps à faire cela, aucun outil ne le supporte et les hacks que j'ai essayé de mettre en place ont engendré trop de difficultés, problèmes...
Par conséquent, la documentation doit rester une documentation, qui suit une narrative, et à côté de cela, des fichiers README.md continuent à exister dans les dossiers des services, outils, environnement... qui fournissent de la documentation contextuelle.

Todo :

• Faire la liste des générateurs de documentation que j'aimerais tester
  • https://github.com/mkdocs/mkdocs/ (en Python)
  • https://github.com/facebook/docusaurus (basé sur ReactJS)
  • https://www.sphinx-doc.org (en Python)
  • #23
  • https://github.com/vuejs/vitepress (basé sur VueJS)
  • https://github.com/doczjs/docz (basé du GatsbyJS)
  • https://github.com/markdoc/markdoc (en React, créé par Stripe)
  • https://github.com/shuding/nextra (basé sur Next.js)
  • https://vuepress.vuejs.org/ (basé sur VueJS)
  • https://github.com/rust-lang/mdBook (en Rust)
• Tester
• ...

Tableau de comparaison : https://docs.google.com/spreadsheets/d/1xZlg0nabIUTH54xzsJ62D5hpc-plDUA8SDkJWp1bFDE/edit?usp=sharing

Mon cahier des charges

• Support d'un moteur de recherche static du style :
  • https://lunrjs.com/
  • ou https://github.com/jameslittle230/stork (qui semble plus moderne)
• Support de TOC sur des pages markdown
• Support page précédente / suivante
• Support i18n, idéalement cette structure d'organisation de fichiers

  /docs/page1.md
  /docs/page1.fr.md
  ...
  

• Support du placement des ressources markdown dans un dossier parent
• Idéalement, possibilité d'implémenter des pages en SSR

Playground repositories

• https://github.com/stephane-klein/docusaurus-playground
• https://github.com/stephane-klein/nextra-playground
• https://github.com/stephane-klein/kit-docs-playground

En travaillant sur stephane-klein/dotfiles#47 (comment) je n'ai pas trouvé de package xremap pour Fedora.

J'aimerais bien pour apprendre essayer de créer un package Fedora de xremap et de le publier sur https://copr.fedorainfracloud.org

J'essaie dans cette issue de suivre toutes les ressources que je lis, que j'écoute au sujet de la "Méritocratie".

Liste :

• Tous winners: Comprendre les logiques du succès - lu en 2016, j'ai adoré !
• Conférence débat François DUBET Egalité des chances, égalité des places
• Cours du collège de France Mérite et « méritocratie ». Motiver l'égalité ou l'inégalité ? de Pierre Michel Menger
  • 2022-08-21 : Je commence Introduction - Définir le mérite ? Analyse sémantique et conceptuelle
  • 2022-08-14 : Origines et histoire de la notion de méritocratie
  • Mérite et méritocratie : pour soi ou pour tous ?

Todo :

• #42 (comment)

I would like to POC https://vite-plugin-ssr.com/react-tour with PostgreSQL

See also #36

Des applications Web comme Salesforce et d'autre, intègre un système de page onglet dans leur application web, à la place d'utiliser le système d'onglet du navigateur, qui est pour moi plus web-centrics.

Le but de cette issue et d'étudier les forces / faibles de ce choix UX.

Todo :

• est-ce que ce choix est motivé par le fait que les users mainstream ne comprennent pas ce qu'est une url, le fonctionnement des onglets du navigateur ?
• est-ce un héritage des applications lourdes ?

Le process de constitution et validation de dossiers administratifs est souvent chronophage, chaotique…

Exemples de dossiers administratifs :

• dossier pour louer un bien à un particulier
• dossier pour louer un bien via une agence immobilière
• dossier demandé par un courtier en prêt immobilier
• dossier pour rejoindre une entreprise en CDI
• dossier de demande de Crédit Impôt Recherche
• ...

Souvent les pièces demandées pour constituer dépendantes de paramètres, exemple :

• nationalité
• pacsé, marié, enfant...
• ...
• premier achat immobilier
• as-tu déjà des prêts
• cdi dans le privé ou fonctionnaire
• ...

Difficultés pour la personne qui constitue le dossier :

• il n'est pas simple d'avoir une liste précise des pièces à fournir
• une fois une pièce du dossier envoyé, il n'est pas toujours facile d'obtenir la validation si la pièce est la bonne, conforme, recevable ou non
• il n'est pas simple de s'assurer qu'on a bien envoyé toutes les pièces, la validation n'est pas simple si on manque de rigueur et la personne destinataire doit, elle aussi, maintenir une check list

Pour la suite je vais définir deux noms d'acteurs :

• utilisateur : la personne qui doit remplir le dossier (c'est la personne qui souhaite louer un bien, commencer un CDI, ouvrir un prêt…)
• admin : la personne qui gère le dossier (l'agence immobilière, le RH dans une boite, le courtier en prêt immobilier…)

Idée de workflow :

• admin : créer le type de dossier avec tous les paramètres
• utilisateur: remplit un formulaire / questionnaire
• Le formulaire remplit par l'utilisateur configure le dossier et génère la liste des pièces que doit fournir l'utilisateur
• L'utilisateur voit dans son interface web, la liste de toutes les pièces à fournir, il voit des "boites" qu'il doit remplir
  • chaque "boite" :
    • contient une explication concernant le document à fournir
    • contient un exemple type du document
    • affiche si le document a été validé / accepté par l'admin
    • un fil de commentaire entre l'utilisateur et l'admin au sujet du document
• L'utilisateur et l'admin peuvent voir facilement avec les boites vides à quel niveau de complétion est le dossier, les pièces qui manquent
• À tout moment ou en fin de process, le admin peut review, valider ou non chaque pièce
• l'admin et l'utilisateur peuvent recevoir des notifications à chaque événement sur le dossier

Le service peut proposer des templates de dossier classique tout fait.

Optionnellement, le service pourrait proposer / inclure des templates tout fait, remplissable en ligne, via une interface web (du type, contrat de bail de location, …).

Optionnellement, une intégration avec Docusign ou autre pourrait être intégré pour gérer les signatures.

Est-ce qu'il existe des services de ce type ? Pour le moment non, pas à ma connaissance, mais je n'ai pas encore cherché.
Par le passé, je suivais la startup https://particulier.greenbureau.fr/ (2011-2015) qui pouvait aller dans cette direction, mais ils semblent ne pas avoir réussi et avoir pivoté.

Todo :

• Chercher si des services de ce type existe déjà
• Améliorer la rédaction de cette issue
• ...

Expliquer dans un article pourquoi je n’apprécie pas les dialog modal dans une application web.

• Effectuer une recherche de ressources sur le sujet
• Expliquer pourquoi je ne trouve pas cela pratique
• Écrire pros / cons modal

Éléments qui doivent être présent dans l'article :

• Avantage d'utiliser des pages (argument opposé aux dialog modal)
  • La page a une url propre (généralement la dialog modal utilise une ancre)
  • Les applications web sont hiérarchisés sous forme de ressources
    • Le breadcrumb indique clairement à l'utilisateur à quel endroit il est présent dans l'application
    • Cela facilite la compréhension de la structure de l'application aussi bien à l'utilisateur qu'au développeur, product owner de l'application
    • Suis le pattern CRUD
  • Cela permet à l'utilisateur de partager le lien de la page
  • Cela permet à l'utilisateur d'ouvrir la page dans un second onglet
  • Cela permet à l'utilisateur d'accéder à la navigation pour aller ailleurs ou ouvrir la page dans un second onglet ou fenêtre

Étudier les ratios écran (16/9, 16/10)… des Macbook, Thinkpad… :

• Macbook Pro M1 16p
• Thinkpad P14s
• Thinkpad X1 Carbon
• Thinkpad Yoga
• Dell XPS 15

Rassembler des ressources au sujet du placement des labels de champs de formulaires.

Choix possibles :

• label ou placeholder
• label + placeholder

Niveau placement des labels :

• label à gauche du champ
• label au dessus du champ

Ressources :

• https://ux.stackexchange.com/questions/9220/on-forms-is-inline-placeholder-text-better-than-a-label-outside-each-field
• https://ux.stackexchange.com/questions/29347/form-usability-best-practice-for-field-label-positioning
• https://ux.stackexchange.com/questions/9220/on-forms-is-inline-placeholder-text-better-than-a-label-outside-each-field
• https://ux.stackexchange.com/questions/22945/where-should-form-instructions-or-hints-be-placed
• https://ux.stackexchange.com/questions/77135/are-forms-with-infield-top-aligned-labels-better-than-left-aligned-forms-that-pr?rq=1
• Why Infield Top Aligned Form Labels Are Quickest to Scan
• Why Users Fill Out Forms Faster with Top Aligned Labels