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

docs(multikeys): met à jour README pour usage de clés multiples #318

Merged
merged 9 commits into from
Jan 17, 2022

Conversation

elias75015
Copy link
Contributor

Pull request checklist

Verifiez que votre Pull Request remplit les conditions suivantes :

  • Des tests ont été ajoutés pour les changements (corrections de bugs ou features)
  • De la documentation a été mise à jour ou ajoutée si nécessaire (corrections de bugs ou features)
  • Un build (npm run build) a été lancé localement et s'est correctement déroulé
  • Les exemples impactés par les modifications (npm run samples) ont été testés et validés localement
  • Les tests (npm run test) sont passés localement

Type de Pull request

Quel type de changement cette Pull Request introduit-elle :

  • Bugfix
  • Feature
  • Mise à jour du style du code (syntaxe, renommage de fonctions)
  • Refactoring (lisibilité/performance du code, sans changements fonctionnels)
  • Changement sur le processus de build
  • Contenu de la documentation
  • Autres (décrire ci-après) :

Quel est le comportement actuel (avant PR) :

Numéro du ticket : N/A

Quel est le nouveau comportement :

Documentation des README pour le chargement de nos interfaces en multikeys.

Cette PR introduit-elle des breaking changes ?

  • Oui
  • Non

Autres informations

Les comportements sont différents selon les APIs sous jacentes :

  • avec l'extension gp pour ol : passage de clés multiples par tag data-key ou param apikey de getconfig possible
  • avec l'extension gp pour itowns : passage de clés multiples par tag data-key ou param apikey de getconfig possible, sauf pour les services directement appelés par l'access-lib. Dans tous les cas, le plus simple reste de renseigner la clé à utiliser dans les paramètres de la couche ou du widget.
  • avec l'extension gp pour leaflet : a priori passage de clés multiples par tag data-key uniquement (non implémenté par getConfig ? étrange)

doc/README-itowns.md Outdated Show resolved Hide resolved
Copy link
Contributor

@lboulanger lboulanger left a comment

Choose a reason for hiding this comment

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

Quelques petites suggestions, sinon OK pour la mise à jour de la doc 👍

doc/README-leaflet.md Outdated Show resolved Hide resolved
doc/README-leaflet.md Outdated Show resolved Hide resolved
doc/README-openlayers.md Outdated Show resolved Hide resolved
@@ -207,7 +213,7 @@ Votre utilisation des fonctionnalités de l'extension Géoportail sera alors sim
<script>
window.onload = function () {
Gp.Services.getConfig({
apiKey: 'CLEAPI',
apiKey: 'VOTRE-CLEF',
Copy link
Contributor

@lboulanger lboulanger Jan 13, 2022

Choose a reason for hiding this comment

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

tu peux rajouter la possibilité de passer plusieurs clés dans le GetConfig ? (et indiquer "CLEF" (ou key) plutôt que "VOTRE-CLEF")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A faire une fois release extension leaflet réalisée : la dernière release ne prend pas en compte les modifications multikeys

@elias75015 elias75015 merged commit 1395eb1 into develop Jan 17, 2022
@elias75015 elias75015 deleted the feature-update-doc branch January 17, 2022 14:52
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.

3 participants