Move documentation from wiki/gh-pages into README#215
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Home.md)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):on_duplicate_key_updatefor adapters that support upserts)What's removed
activeadmin-plugins.github.io/active_admin_import/and the wiki#### Wikisection that linked back to the same wikiWhat's not changed
Test plan
lib/active_admin_import/dsl.rb,options.rb, andmodel.rb)fetch_extra_options_from_paramssnippet 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.