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

[#3688] Add documentation #4028

Merged
merged 3 commits into from
Mar 22, 2024
Merged

[#3688] Add documentation #4028

merged 3 commits into from
Mar 22, 2024

Conversation

Viicos
Copy link
Contributor

@Viicos Viicos commented Mar 20, 2024

Part of #3688, #4019

probably still WIP and missing things

@Viicos Viicos linked an issue Mar 20, 2024 that may be closed by this pull request
3 tasks
Copy link

codecov bot commented Mar 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.07%. Comparing base (75c3268) to head (9841216).
Report is 5 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4028   +/-   ##
=======================================
  Coverage   96.07%   96.07%           
=======================================
  Files         728      728           
  Lines       22867    22867           
  Branches     2654     2654           
=======================================
  Hits        21970    21970           
  Misses        636      636           
  Partials      261      261           

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

@SilviaAmAm SilviaAmAm self-requested a review March 21, 2024 14:14
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
docs/configuration/registration/objects.rst Outdated Show resolved Hide resolved
@Viicos
Copy link
Contributor Author

Viicos commented Mar 21, 2024

Wow, that's a lot of typos, thanks for reviewing


Below is an example of the contents in the ``record.data`` attribute in the
Copy link
Member

Choose a reason for hiding this comment

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

Decided to remove this, there is no added benefit for functional admins since they're not typically involved with form-configuration, and it's way too technical for form designers.

The Productaanvraag objecttype is linked above, that should be sufficient :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes wasn't sure what to do with this

docs/manual/registration/objects-api.rst Show resolved Hide resolved
docs/manual/registration/objects-api.rst Outdated Show resolved Hide resolved
docs/manual/registration/objects-api.rst Outdated Show resolved Hide resolved
docs/manual/registration/objects-api.rst Show resolved Hide resolved
Viicos and others added 3 commits March 22, 2024 14:30
These fields are obsolete and scheduled for removal. Their values have
been copied into the respective forms where they were not set explicitly
yet.
* Updated technical (functional admin) documentation
* Documented minimum required version of Objects API 2.2
* Removed distinction between new/legacy - the form fields are marked
  as required anyway and the nuance is not interesting.
* Translated the manual documentation to Dutch
* Moved form-level manual documentation into registrations section
* Added extra pointers on how to configure this thing, with a bit more
  logical progression.
@sergei-maertens sergei-maertens merged commit 5d85702 into master Mar 22, 2024
27 checks passed
@sergei-maertens sergei-maertens deleted the feature/3688-docs branch March 22, 2024 14:13
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.

Objects API "contract" feature - release blockers
3 participants