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

[API Statut étudiant boursier] Correction de la documentation #1696

Merged
merged 9 commits into from
Dec 17, 2024

Conversation

Miryad3108
Copy link
Contributor

Suite à mon point avec le CNOUS le 11.10, j'ai modifié la doc pour :

  • ajouter de nouvelles régions pour les bourses sanitaires et sociales (et retirer la région Normandie, qui n'est pas inclus)
  • retirer les DROM dans les territoires que couvre l'API (pas encore conventionnés donc non inclus)
  • supprimer la mention qui dit que ça n'inclut que les boursiers français : pas de distinction de nationalité, tant qu'ils ont une bourse gérée par le CNOUS ou une bourse régionale, ils sont inclus. J'ai modifié en mettant que ça n'intègre pas les bourses étrangères (même ceux de l'UE). ça me paraît évident, mais sait on jamais.

Suite à mon point avec le CNOUS le 11.10, j'ai modifié la doc pour : 
- ajouter de nouvelles régions pour les bourses sanitaires et sociales (et retirer la région Normandie, qui n'est pas inclus)
- retirer les DROM dans les territoires que couvre l'API (pas encore conventionnés donc non inclus)
- supprimer la mention qui dit que ça n'inclut que les boursiers français : pas de distinction de nationalité, tant qu'ils ont une bourse gérée par le CNOUS ils sont inclus. J'ai modifié en mettant que ça n'intègre pas les bourses étrangères (même ceux de l'UE). ça me paraît évident, mais sait on jamais.
@Miryad3108 Miryad3108 requested a review from DorineLam October 15, 2024 05:00
Copy link
Contributor

@DorineLam DorineLam left a comment

Choose a reason for hiding this comment

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

Coucou Miryad ! Merci beaucoup, voici des retours :)

L'API délivre les données :
- ✅ des **boursiers d’État sur critères sociaux (gérés par les Crous)** ;
- ✅ des **boursiers sur critères sociaux des filières sanitaires et sociales** des régions Normandie et Occitanie. D'autres régions devraient être couvertes à l'avenir.
L'API délivre les données sur :
Copy link
Contributor

Choose a reason for hiding this comment

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

@Miryad3108 mais en fait, ce n'est plus d'actualité, non ? Vu que le statut provisoire concerne en fait l'échelon de bourse ?

Copy link
Contributor

@DorineLam DorineLam left a comment

Choose a reason for hiding this comment

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

@Miryad3108 proposition de changements

- ✅ des **boursiers sur critères sociaux des filières sanitaires et sociales** des régions Normandie et Occitanie. D'autres régions devraient être couvertes à l'avenir.
L'API délivre les données sur :
- ✅ **le statut de bourse définitif pour les boursiers d’État sur critères sociaux (gérés par les Crous)** ;
- ✅ **le statut de bourse provisoire et définitif pour les boursiers sur critères sociaux des filières sanitaires et sociales** des régions Occitanie, Grand Est, Bourgogne-Franche-Comté, Bretagne et Auvergne-Rhône-Alpes. D'autres régions devraient être couvertes à l'avenir.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- ✅ **le statut de bourse provisoire et définitif pour les boursiers sur critères sociaux des filières sanitaires et sociales** des régions Occitanie, Grand Est, Bourgogne-Franche-Comté, Bretagne et Auvergne-Rhône-Alpes. D'autres régions devraient être couvertes à l'avenir.
- ✅ **des boursiers sur critères sociaux des filières sanitaires et sociales** des régions Occitanie, Grand Est, Bourgogne-Franche-Comté, Bretagne et Auvergne-Rhône-Alpes. D'autres régions devraient être couvertes à l'avenir.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

On peut quand même introduire la notion de provisoire/définitif ? Qu'elle apparaisse quelque part dans la documentation métier parce que c'est important que les FS sachent qu'il y a cette nuance dans l'API vu qu'il y a des aides basées sur l'échelon de la bourse. ça arrive assez souvent que des personnes pas du tout tech lisent la doc et qu'elles n'aillent pas jusqu'à la section "Données distribuées" (qu'elles découvrent avec moi en appel)
comme :

  • des boursiers sur critères sociaux des filières sanitaires et sociales avec une précision sur le statut provisoire ou définitif de l'échelon de la bourse des régions Ile-de-France, Occitanie, Grand Est, Bourgogne Franche-Comté, Bretagne et Auvergne-Rhône-Alpes. D'autres régions devraient être couvertes à l'avenir.

@DorineLam

Copy link
Contributor

Choose a reason for hiding this comment

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

J'ai passé en revue le problème @Miryad3108. Je ne peux pas mettre cette info du statut ici parce que cela déstructure les sections. ça revient à qualifier la donnée, là où on cherche à expliquer quel public est concerné (même si j'entends que le statut provisoire de l'échelon concerne uniquement les régions.

Je vais essayer de faire une proposition

Copy link
Contributor

Choose a reason for hiding this comment

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

Restructure pour mettre les infos au bon endroit et réduire la taille des phrases :

image

Ajout d'une précision dans la description de la donnée

image

@DorineLam DorineLam changed the title Correction de la documentation [API Statut étudiant boursier] Correction de la documentation Dec 6, 2024
- ✅ des **boursiers sur critères sociaux des filières sanitaires et sociales** des régions Normandie et Occitanie. D'autres régions devraient être couvertes à l'avenir.
L'API délivre les données sur :
- ✅ **le statut de bourse définitif pour les boursiers d’État sur critères sociaux (gérés par les Crous)** ;
- ✅ **le statut de bourse provisoire et définitif pour les boursiers sur critères sociaux des filières sanitaires et sociales** des régions Occitanie, Grand Est, Bourgogne-Franche-Comté, Bretagne et Auvergne-Rhône-Alpes. D'autres régions devraient être couvertes à l'avenir.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Île-de-France

- ✅ des **boursiers sur critères sociaux des filières sanitaires et sociales** des régions Normandie et Occitanie. D'autres régions devraient être couvertes à l'avenir.
L'API délivre les données sur :
- ✅ **le statut de bourse définitif pour les boursiers d’État sur critères sociaux (gérés par les Crous)** ;
- ✅ **le statut de bourse provisoire et définitif pour les boursiers sur critères sociaux des filières sanitaires et sociales** des régions Occitanie, Grand Est, Bourgogne-Franche-Comté, Bretagne et Auvergne-Rhône-Alpes. D'autres régions devraient être couvertes à l'avenir.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

On peut quand même introduire la notion de provisoire/définitif ? Qu'elle apparaisse quelque part dans la documentation métier parce que c'est important que les FS sachent qu'il y a cette nuance dans l'API vu qu'il y a des aides basées sur l'échelon de la bourse. ça arrive assez souvent que des personnes pas du tout tech lisent la doc et qu'elles n'aillent pas jusqu'à la section "Données distribuées" (qu'elles découvrent avec moi en appel)
comme :

  • des boursiers sur critères sociaux des filières sanitaires et sociales avec une précision sur le statut provisoire ou définitif de l'échelon de la bourse des régions Ile-de-France, Occitanie, Grand Est, Bourgogne Franche-Comté, Bretagne et Auvergne-Rhône-Alpes. D'autres régions devraient être couvertes à l'avenir.

@DorineLam

@DorineLam
Copy link
Contributor

@Miryad3108 suite à ta remarque sur le fait que les FS ne lisent pas la section "données", j'ai fait un premier changement qui me semble utile pour l'API QF. J'ai mis les infos de la modalité d'appel "Identité pivot" dans un accordéon :

Accordéon replié, qui permet de voir la section "données"

image

Accordéon ouvert avec toutes les infos

image

@Miryad3108
Copy link
Contributor Author

Je trouve ces propositions très bien @DorineLam , merci !

@DorineLam DorineLam merged commit 8a345bf into develop Dec 17, 2024
9 checks passed
@DorineLam DorineLam deleted the Miryad3108-patch-6 branch December 17, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants