feat: add API FAQ page. #829
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vjousse
approved these changes
Nov 13, 2024
vjousse
pushed a commit
that referenced
this pull request
Nov 20, 2024
## [2.6.0](https://github.com/MTES-MCT/ecobalyse/compare/v2.5.0..v2.6.0) (2024-11-20) ### 🚀 Features - Add API FAQ page. ([#829](#829)) - Intégration Laine woolmark ([#831](#831)) ### ⚙️ Miscellaneous Tasks - Upgrade dependencies, Nov. 2024. ([#830](#830)) - *(data)* Fixed typo paysane→paysanne ([#836](#836)) <!-- generated by git-cliff --> Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔧 Problem
User Story
Same questions come over and over on Mattermost, it's time to create a FAQ page for the API.
🍰 Solution
Create a FAQ page for the API.
🚨 Points to watch/comments
I don't have the guts to elaborate on commercial and EI intellectual property aspects in this FAQ (eg. "can I use the API results for commercial projects?" and so on), feel free to jump in with legalese provided you'll assume adding, maintaining and take responsibility of it over time.
🏝️ How to test
Check that the page is properly linked from the API page and answers most common questions one could ask about it. Also check for typos and phrasing.