Add management commands to export/import mega menu #6011
Merged
Conversation
This file contains 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
This commit adds two new management commands for exporting and importing mega menu content to and from JSON. These commands will enable easier and more repeatable updating of menu content. To export: cfgov/manage.py export_mega_menu language output.json OR cfgov/manage.py export_mega_menu language (writes to stdout) For example: cfgov/manage.py export_mega_menu en current.json To import: cfgov/manage.py import_mega_menu language input.json OR cfgov/manage.py import_mega_menu language (reads from stdin) For example: cat new.json | cfgov/manage.py import_mega_menu en The JSON format used is the content of the existing Menu object's submenus StreamField. For testing purposes, I've created two JSON files that can be used to switch back and forth between the current site mega menu and an alternate one. Assuming that you have github.local aliased to our internal GHE server, you can run these commands to toggle back and forth. Current menu: curl -k https://github.local/raw/gist/chosak/4600af0d52fbe588a634ea6fee54f942/raw/5af1c1428f63ddfd7f6fc8ba9fa115b0ac17235a/current.json | cfgov/manage.py import_mega_menu en New menu: curl -k https://github.local/raw/gist/chosak/fdeab64f382ca0d17568cdbd717862d8/raw/9b2e8fb73062ec631c609d69c1e9ee49261b6459/new.json | cfgov/manage.py import_mega_menu en
3 tasks
schbetsy
approved these changes
Sep 16, 2020
|
|
||
|
|
||
| class Command(BaseCommand): | ||
| help = 'Import mega menu content as JSON' |
There was a problem hiding this comment.
Maybe add that it will overwrite any existing mega menu for the given language?
There was a problem hiding this comment.
Nice suggestion, @schbetsy. Unfortunately it's tricky to add multiple lines in command help, so we're limited to one line here. I went with "Import (and overwrite) language-specific mega menu content as JSON." -- does that capture this well?
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.
This commit adds two new management commands for exporting and importing mega menu content to and from JSON. These commands will enable easier and more repeatable updating of menu content.
How to test this PR
To export:
cfgov/manage.py export_mega_menu language output.jsonOR
cfgov/manage.py export_mega_menu language(writes to stdout)For example:
cfgov/manage.py export_mega_menu en current.jsonTo import:
cfgov/manage.py import_mega_menu language input.jsonOR
cfgov/manage.py import_mega_menu language(reads from stdin)For example:
cat new.json | cfgov/manage.py import_mega_menu enThe JSON format used is the content of the existing
Menuobject'ssubmenusStreamField. For testing purposes, I've created two JSON files that can be used to switch back and forth between the current site mega menu and an alternate one. Assuming that you havegithub.localaliased to our internal GHE server, you can run these commands to toggle back and forth.Current menu:
curl -k https://github.local/raw/gist/chosak/4600af0d52fbe588a634ea6fee54f942/raw/5af1c1428f63ddfd7f6fc8ba9fa115b0ac17235a/current.json | cfgov/manage.py import_mega_menu enNew menu:
curl -k https://github.local/raw/gist/chosak/fdeab64f382ca0d17568cdbd717862d8/raw/9003c98fd5df83a77bd4291b7a8d09eb509d7642/new.json | cfgov/manage.py import_mega_menu enChecklist