Skip to content

Add documentation on library backup & restore - #1335

Merged
sarina merged 3 commits into
mainfrom
sarina/libraries-backup
Dec 11, 2025
Merged

Add documentation on library backup & restore#1335
sarina merged 3 commits into
mainfrom
sarina/libraries-backup

Conversation

@sarina

@sarina sarina commented Dec 1, 2025

Copy link
Copy Markdown
Contributor

@sarina
sarina requested review from ormsbee and sdaitzman December 1, 2025 19:58
@sarina

sarina commented Dec 4, 2025

Copy link
Copy Markdown
Contributor Author

@sdaitzman

Copy link
Copy Markdown

Thanks @sarina, this looks great to me. I reviewed the documentation and they instructions are clear and cover the details well.

The one area of feedback I have is around naming-- because Content Libraries support a separate "Import" feature that is a course → library content import, I would recommend avoiding naming overlap for this documentation page and its sections. As of the last time we discussed this, I think we wanted to use "Backup to local archive" and "Create from archive" or "Restore from archive" to avoid the naming overlap. @jmakowski1123 may have additional thoughts (also CC @edschema)

The naming overlap between different platform features (import / export / backup / restore / migrate) is confusing, and I think it would be worth standardizing at some point. For now, I think limiting the overlap will help reduce possible confusion (especially since the Library menu Tools → Import is for course to library content import, not restore-from-backup).

@sdaitzman sdaitzman left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me, requesting some very minor changes to phrasing to avoid overlap between create-from-archive and course import tools

Comment thread source/educators/how-tos/course_development/import_export_library.rst Outdated
Comment thread source/educators/how-tos/course_development/import_export_library.rst Outdated

#. When the import process finishes, you'll be taken to your new library.

.. seealso::

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder about also linking to migration and course import documentation here, since those are related concepts that enable users to move content back and forth between different areas of the platform

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have links to the documentation you're mentioning?

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking into whether we have documentation for those areas; unfortunately I think they may be additional gaps

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By "migration" do you mean these? #1340

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise, could you possibly make some issues for the missing docs and approve this PR, and we can write up the missing docs & link them here as they're written

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By "migration" do you mean these? #1340

Yes

Otherwise, could you possibly make some issues for the missing docs and approve this PR, and we can write up the missing docs & link them here as they're written

Added an issue for import documentation: #1348

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this reference, it seems like #1348 isn't ready for documentation yet so we don't need to reference it yet, and we can move forward with merging this PR. Would you agree?

@jmakowski1123

Copy link
Copy Markdown
Contributor

Thanks @sarina, this looks great to me. I reviewed the documentation and they instructions are clear and cover the details well.

The one area of feedback I have is around naming-- because Content Libraries support a separate "Import" feature that is a course → library content import, I would recommend avoiding naming overlap for this documentation page and its sections. As of the last time we discussed this, I think we wanted to use "Backup to local archive" and "Create from archive" or "Restore from archive" to avoid the naming overlap. @jmakowski1123 may have additional thoughts (also CC @edschema)

The naming overlap between different platform features (import / export / backup / restore / migrate) is confusing, and I think it would be worth standardizing at some point. For now, I think limiting the overlap will help reduce possible confusion (especially since the Library menu Tools → Import is for course to library content import, not restore-from-backup).

Agree we don't want duplicative naming for Import. We did land on "Backup to local archive" and "Restore from archive".

@sarina sarina changed the title Add documentation on library import and export Add documentation on library backup & restore Dec 10, 2025
@sarina
sarina force-pushed the sarina/libraries-backup branch from ba943c4 to f6b39a4 Compare December 10, 2025 21:54
@sarina

sarina commented Dec 10, 2025

Copy link
Copy Markdown
Contributor Author

@jmakowski1123 I had already adjusted the language to use Backup/Restore, please let me know if you think I missed something!

@sarina
sarina merged commit 5355e76 into main Dec 11, 2025
2 checks passed
@sarina
sarina deleted the sarina/libraries-backup branch December 11, 2025 21:25
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.

3 participants