-
Notifications
You must be signed in to change notification settings - Fork 78
Add documentation on library backup & restore #1335
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
113 changes: 113 additions & 0 deletions
113
source/educators/how-tos/course_development/backup_restore_library.rst
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| .. _Backup and Restore a Library: | ||
|
|
||
| Backup and Restore a Library | ||
| ################################### | ||
|
|
||
| .. tags:: educator, how-to | ||
|
|
||
| .. contents:: | ||
| :local: | ||
| :depth: 1 | ||
|
|
||
| You can :ref:`backup<Backup a Library>` and :ref:`restore<Restore a Library>` a | ||
| content library in Studio. | ||
|
|
||
| .. _Backup a Library: | ||
|
|
||
| Backup A Library To Local Archive | ||
| ********************************* | ||
|
|
||
| There are several reasons why you might want to backup your library. | ||
|
|
||
| * To save your work in progress | ||
| * To edit the XML in your library directly | ||
| * To create a backup copy of your library | ||
| * To share with another course team member | ||
|
|
||
| When you backup your library, Studio creates a **.zip** file for export. This | ||
| export file contains the problems in the library, including any customizations | ||
| you made in the library to problem settings. The export does not include library | ||
| settings such as user access permissions. | ||
|
|
||
| To backport a library, follow these steps. | ||
|
|
||
| #. In Studio, select the **Libraries** tab. | ||
|
|
||
| #. Locate the library that you want to backup. | ||
|
|
||
| #. From the **Tools** menu, select **Backup to local archive**. | ||
|
|
||
| .. image:: /_images/educator_how_tos/library_backup_1.png | ||
| :alt: A screenshot of the Library Tools menu, with the first option being "Backup to local archive" | ||
|
|
||
| #. Select **Download Library Backup** next to your library's name to dowload the archive. | ||
|
|
||
| .. image:: /_images/educator_how_tos/library_backup_2.png | ||
| :alt: A screenshot of the Library Backup page, with the library name to the left of a button that reads "Download Library Backup" | ||
|
|
||
| When the export process finishes, you can access the ``.zip`` file on your | ||
| computer. | ||
|
|
||
| .. _Restore a Library: | ||
|
|
||
| Create a Library From An Archive | ||
| ******************************** | ||
|
|
||
| .. note:: | ||
|
|
||
| For the Ulmo release, Create Library From Archive is only supported as a way to initialize a new library. | ||
|
|
||
| The library file that you import must be a ``.zip`` file that contains a | ||
| ``package.toml`` file. | ||
|
|
||
| To create a library from an archive, follow these steps. | ||
|
|
||
| #. In Studio, select the **+ New library** button in the top right. | ||
|
|
||
| .. image:: /_images/educator_how_tos/new_library_button.png | ||
| :alt: The "+New Library" button appears in the top right corner of the Studio homepage | ||
|
|
||
| #. Select **Create from archive** button in the top right. | ||
|
|
||
| .. image:: /_images/educator_how_tos/create_library_from_archive.png | ||
| :alt: The "Create from archive" button appears in the top right corner of the "Create new library" page | ||
|
|
||
| #. Drag and drop the file, or click to upload, your ``.zip`` file. | ||
|
|
||
| #. After your file is uploaded, you'll see information about the imported | ||
| library at the top of the screen: | ||
|
|
||
| .. image:: /_images/educator_how_tos/library_import_screen.png | ||
| :alt: The "Create library" page with information about the uploaded library | ||
|
|
||
| #. Enter in the name, organization, and Library ID for the library. | ||
|
|
||
| #. When the import process finishes, you'll be taken to your new library. | ||
|
|
||
| .. seealso:: | ||
|
|
||
| :ref:`Navigate the Library Homepage` | ||
|
|
||
| :ref:`Create and edit content in a Library` | ||
|
|
||
| :ref:`Create and edit units in a Library` | ||
|
|
||
| :ref:`Build a Collection in a Library` | ||
|
|
||
| :ref:`Migrating Legacy Libraries` | ||
|
|
||
| :ref:`Publish Library content` | ||
|
|
||
| :ref:`Add and Delete tags in Library content` | ||
|
|
||
| :ref:`Add a Problem Bank to your course for randomization` | ||
|
|
||
| :ref:`Add users to Libraries` | ||
|
|
||
| **Maintenance chart** | ||
|
|
||
| +--------------+-------------------------------+----------------+---------------------------------------------------------------+ | ||
| | Review Date | Working Group Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+---------------------------------------------------------------+ | ||
| | 2025-12-01 | Sarina | Ulmo | Pass | | ||
| +--------------+-------------------------------+----------------+---------------------------------------------------------------+ | ||
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
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes
Added an issue for import documentation: #1348
There was a problem hiding this comment.
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?