📝 [#564] refactor docs for objecttype migrations

[Floris272]

Fixes #564

Changes

• updates docs

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.86%. Comparing base (0ea556d) to head (fcc0fea).
⚠️ Report is 8 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #737      +/-   ##
==========================================
+ Coverage   85.58%   85.86%   +0.28%     
==========================================
  Files         144      144              
  Lines        3003     3021      +18     
  Branches      236      239       +3     
==========================================
+ Hits         2570     2594      +24     
+ Misses        381      376       -5     
+ Partials       52       51       -1     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

Bencher Report

Branch	feature/564-docs
Testbed	ubuntu-24.04

Click to view all benchmark results

Benchmark	Latency	Benchmark Result milliseconds (ms) (Result Δ%)	Upper Boundary milliseconds (ms) (Limit %)
performance_test/tests/test_objects_list.py::test_objects_api_list_filter_by_object_type	📈 view plot 🚷 view threshold	124.11 ms (+0.84%) Baseline: 123.08 ms	129.23 ms (96.04%)
performance_test/tests/test_objects_list.py::test_objects_api_list_filter_one_result	📈 view plot 🚷 view threshold	19.29 ms (+2.39%) Baseline: 18.84 ms	19.78 ms (97.52%)
performance_test/tests/test_objects_list.py::test_objects_api_list_large_page_size_page_1	📈 view plot 🚷 view threshold	295.94 ms (-2.91%) Baseline: 304.80 ms	320.04 ms (92.47%)
performance_test/tests/test_objects_list.py::test_objects_api_list_large_page_size_page_5	📈 view plot 🚷 view threshold	300.74 ms (-9.49%) Baseline: 332.29 ms	348.90 ms (86.20%)
performance_test/tests/test_objects_list.py::test_objects_api_list_small_page_size_page_20	📈 view plot 🚷 view threshold	129.24 ms (+2.94%) Baseline: 125.55 ms	131.83 ms (98.04%)

🐰 View full continuous benchmarking report in Bencher

[stevenbal]

I didn't know we had this performance test setup for Objects as well actually 😅

Suggested change

	We run the tests after every major version of the Open Objecten API.
	We run the tests after every major version of the Open Objecten.

[Floris272]

It seems that the most recent test was done for 2.0.0-alpha, so it should probably be reset if we do it for 4.0.0 or be removed

[stevenbal]

Hmm yeah, and this data also seems to be with only 500 objects and a single user doing requests (no concurrency).

I'd say we remove it and redo this properly later on with a better setup (more realistic data, higher concurrency, running on k8s)

[stevenbal]

Hmm yeah, and this data also seems to be with only 500 objects and a single user doing requests (no concurrency).

I'd say we remove it and redo this properly later on with a better setup (more realistic data, higher concurrency, running on k8s)

[stevenbal]

On second thought, because this is about the version of the application, let's remove API from the heading as well

[stevenbal]

Could you also make sure the objects namespace is updated to the new namespace in the other examples? The same must be done for the metrics defined in code as well

[stevenbal]

I tried testing these locally, the metrics above this that are still under the objects namespace work, but this one doesn't seem to work for me:

Does this happen for you as well?

[Floris272]

i got otel_openobjecten_object_creates_total working from the docs example, it does take a few seconds before prometeus has it.