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

Add/update documentation for product prefill #4919

Merged
merged 2 commits into from
Dec 17, 2024

Conversation

sergei-maertens
Copy link
Member

Changes

  • Updated technical configuration documentation
  • Split user manual/technical documentation
  • Added example of how to set up a form with product prefill

Checklist

Check off the items that are completed or not relevant.

  • Impact on features

    • Checked copying a form
    • Checked import/export of a form
    • Config checks in the configuration overview admin page
    • Problem detection in the admin email digest is handled
  • Release management

    • I have labelled the PR as "needs-backport" accordingly
  • I have updated the translations assets (you do NOT need to provide translations)

    • Ran ./bin/makemessages_js.sh
    • Ran ./bin/compilemessages_js.sh
  • Dockerfile/scripts

    • Updated the Dockerfile with the necessary scripts from the ./bin folder
  • Commit hygiene

    • Commit messages refer to the relevant Github issue
    • Commit messages explain the "why" of change, not the how

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.61%. Comparing base (486d9cb) to head (1e31833).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4919      +/-   ##
==========================================
- Coverage   96.62%   96.61%   -0.01%     
==========================================
  Files         760      760              
  Lines       25818    25817       -1     
  Branches     3382     3382              
==========================================
- Hits        24947    24944       -3     
- Misses        606      608       +2     
  Partials      265      265              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@stevenbal stevenbal left a comment

Choose a reason for hiding this comment

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

Minor comments, looks good overall

docs/configuration/prefill/objects_api.rst Outdated Show resolved Hide resolved
docs/configuration/prefill/objects_api.rst Outdated Show resolved Hide resolved
docs/configuration/prefill/objects_api.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/manual/forms/examples/objects_prefill.rst Outdated Show resolved Hide resolved
docs/manual/forms/examples/objects_prefill.rst Outdated Show resolved Hide resolved
* Updated some outdated registration plugin docs
* Structured the prefill docs the same way

It's important to separate the upfront technical configuration (aimed
at technical administrators) from the manual which describes how to
use the feature.

Another commit will add the functional user manual documentation as an
example form.
@sergei-maertens sergei-maertens merged commit 738be59 into master Dec 17, 2024
27 of 29 checks passed
@sergei-maertens sergei-maertens deleted the docs/product-prefill branch December 17, 2024 15:26
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