Docs: improve ingestion tutorial - #2376
Open
nhoening wants to merge 6 commits into
Open
Conversation
Context: - New users need a clearer path from a first file upload to an automated ingestion pipeline. Change: - Refactor the existing posting-data tutorial around Client 0.9.4, Excel/CSV, export scripts, verification, and an optional UI checkpoint. - Add a standalone Docker QA runner and update the tutorial script guidance.
Context: - The executable ingestion tutorial exposed that Docker workers reject XLSX uploads because openpyxl was test-only. Change: - Promote openpyxl to a default dependency and update the lockfile so production installations can process advertised Excel uploads.
Context: - Tutorial examples should remain executable in both synchronous and queued Docker deployments. Change: - Run the ingestion tutorial in Docker build and release QA workflows using the current client checkout. - Exclude that host-side client checkout from the Docker build context.
Context: - Review identified safer password handling and several points that should be more explicit for new users. Change: - Prompt interactively for passwords, document CI toy credentials, clarify export values and optional verification, and remove the client upper bound. - Rename the verification helper and correct the sixth toy tutorial's numbering and navigation order.
Context: - The ingestion tutorial may be run with different integration accounts. Change: - Include the configured email address in interactive password prompts in both the tutorial and executable script.
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
Documentation build overview
11 files changed ·
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
We got feedback that early users do not have enough hand-holding on how to get data into FlexMeasures and build their own data pipelines.
documentation/changelog.rst