Skip to content

Move documentation from wiki/gh-pages into README#215

Merged
Fivell merged 1 commit intomasterfrom
readme-docs
Apr 8, 2026
Merged

Move documentation from wiki/gh-pages into README#215
Fivell merged 1 commit intomasterfrom
readme-docs

Conversation

@Fivell
Copy link
Copy Markdown
Member

@Fivell Fivell commented Apr 8, 2026

Summary

Consolidates the still-relevant snippets from the wiki and the gh-pages site into the README, and drops the links to those external sources. Both the wiki and the gh-pages site have been stale for years, so docs that live next to the code are easier for users to find and easier for us to keep current.

What's added to the README

  • Authorization — minimal CanCanCan example (was in Home.md)
  • Per-request context — short example of active_admin_import_context (the convention introduced in Add active_admin_import_context convention for controller-provided context #211 — was previously undocumented in the README)
  • Examples section consolidating the wiki pages, each as a small focused snippet:
    • Files without CSV headers
    • Auto-detect file encoding
    • Force a specific (non-UTF-8) encoding
    • Disallow ZIP upload
    • Skip CSV columns
    • Resolve associations on the fly
    • Update existing records by id (with a note pointing at :on_duplicate_key_update for adapters that support upserts)
    • Tune batch size
    • Import into an intermediate table
    • Allow user input for CSV options (custom template + ERB)
    • Inspecting the importer in batch callbacks

What's removed

  • The intro line pointing at activeadmin-plugins.github.io/active_admin_import/ and the wiki
  • The trailing #### Wiki section that linked back to the same wiki

What's not changed

  • The badges, Installation, Features, Basic usage, Options table, Custom ImportResult, Dependencies, and Contributing sections are all left alone
  • No code changes — README only

Test plan

  • Reviewed README rendering manually
  • All migrated snippets reflect the current public API (verified against lib/active_admin_import/dsl.rb, options.rb, and model.rb)
  • Stale fetch_extra_options_from_params snippet from the wiki Home page was dropped (the option no longer exists in the codebase)

Follow-up

Once this is merged, the wiki and gh-pages site can either be deleted or have a notice added pointing readers at the README.

The wiki and the gh-pages site have been stale for years. Consolidate
the still-relevant snippets into the README so the canonical docs live
next to the code, and drop the links to the outdated external sites.

Adds:
- Authorization (CanCanCan example)
- Per-request context (active_admin_import_context)
- Examples section covering files without headers, encoding handling,
  disallowing zip uploads, skipping CSV columns, resolving associations,
  update-by-id, batch sizing, intermediate-table imports, custom CSV
  options template, and the importer object exposed to batch callbacks
@Fivell Fivell merged commit 688e5e1 into master Apr 8, 2026
36 checks passed
@Fivell Fivell mentioned this pull request Apr 8, 2026
5 tasks
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.

1 participant