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

📝 [#4882] Documentation for ConfigurationSteps #5020

Merged
merged 5 commits into from
Jan 28, 2025

Conversation

stevenbal
Copy link
Contributor

@stevenbal stevenbal commented Jan 16, 2025

Closes #4882

Changes

  • Documentation for ConfigurationSteps

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

@stevenbal stevenbal marked this pull request as draft January 16, 2025 15:20
@stevenbal stevenbal force-pushed the feature/4882-document-setup-config-steps branch 2 times, most recently from fa59b05 to 47bc03a Compare January 21, 2025 09:54
Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.67%. Comparing base (1658eca) to head (a66270c).
Report is 27 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5020   +/-   ##
=======================================
  Coverage   96.67%   96.67%           
=======================================
  Files         765      765           
  Lines       26131    26131           
  Branches     3407     3407           
=======================================
  Hits        25262    25262           
  Misses        606      606           
  Partials      263      263           

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

@stevenbal stevenbal force-pushed the feature/4882-document-setup-config-steps branch 2 times, most recently from 8dd7768 to ff2f64e Compare January 21, 2025 13:00
@stevenbal stevenbal changed the title 🚧 [#4882] Documentation for ConfigurationSteps 📝 [#4882] Documentation for ConfigurationSteps Jan 21, 2025
@stevenbal stevenbal force-pushed the feature/4882-document-setup-config-steps branch 2 times, most recently from c6dc558 to 004badf Compare January 21, 2025 16:15
@stevenbal stevenbal force-pushed the feature/4882-document-setup-config-steps branch 3 times, most recently from 5a28b62 to 17eca7d Compare January 27, 2025 14:34
@stevenbal stevenbal marked this pull request as ready for review January 27, 2025 14:34
@stevenbal stevenbal force-pushed the feature/4882-document-setup-config-steps branch from 17eca7d to d9996e1 Compare January 27, 2025 14:45
@stevenbal stevenbal force-pushed the feature/4882-document-setup-config-steps branch from d9996e1 to c198c3c Compare January 27, 2025 15:38
Using the YAML example directive from django-setup-configuration.
Also adds help texts and examples where needed to make sure these are picked up by the directive.
@stevenbal stevenbal force-pushed the feature/4882-document-setup-config-steps branch from c198c3c to a66270c Compare January 27, 2025 15:41
@sergei-maertens sergei-maertens merged commit e5c783a into master Jan 28, 2025
33 checks passed
@sergei-maertens sergei-maertens deleted the feature/4882-document-setup-config-steps branch January 28, 2025 16:10
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.

Add documentation for setup-configuration steps
2 participants