Migration-workflow.md

@@ -26,7 +26,7 @@ Run gfs_validate_tranche_csv.py.
 
 Run gfs_create_tranche_folder.py and list all the types of asset-folders that should be in the tranche.
 
-Run gfs_create_or_delete_tranche_checksum_folder.py with the <action> parameter set to "create_folder" and list the same set of asset-folders that were present in the previous command line.
+Run gfs_create_or_delete_tranche_checksum_folder.py with the \<action\> parameter set to "create_folder" and list the same set of asset-folders that were present in the previous command line.
 
 It is only possible to migrate asset-files for one type of asset-folder at a time, and the child-folder cells in the "gfs.legacyPath" column must be set, prior to running the gfs_migrate_tranche_folder.py script, to template-values that are appropriate for legacy locations of the asset-files to be migrated.
 
@@ -36,29 +36,29 @@ Therefore, the following steps should be performed for each asset-folder type th
 
  - Run gfs_validate_tranche_csv.py (this is needed in case you’ve accidentally deleted/modified some metadata within the tranche.csv file while populating the “gfs.legacyPath” column)
 
- - Run gfs_migrate_tranche_folder.py with <action> set to “test” (this flags up any asset-folder within a child-folder that will not be populated with any asset-files. If this is the case, the relevant entry in the "gfs.legacyPath" column of the tranche csv should be corrected)
+ - Run gfs_migrate_tranche_folder.py with \<action\> set to “test” (this flags up any asset-folder within a child-folder that will not be populated with any asset-files. If this is the case, the relevant entry in the "gfs.legacyPath" column of the tranche csv should be corrected)
 
- - Run gfs_create_tranche_checksum_file.py with <asset file location> set to “legacy” (this creates checksums in checksum-manifest-files in the checksum-folders that correspond to the content of the asset-files in the their legacy location).
+ - Run gfs_create_tranche_checksum_file.py with \<asset file location\> set to “legacy” (this creates checksums in checksum-manifest-files in the checksum-folders that correspond to the content of the asset-files in the their legacy location).
 
- - Run gfs_validate_tranche_checksum.py with <asset file location> set to “legacy”.
+ - Run gfs_validate_tranche_checksum.py with \<asset file location\> set to “legacy”.
 
  - Run gfs_migrate_tranche_folder.py with <action> set to “copy”.
 
- - Run gfs_validate_tranche_folder.py for the asset-folder, setting the <gfs filenaming convention flag> parameter to “n”.
+ - Run gfs_validate_tranche_folder.py for the asset-folder, setting the \<gfs filenaming convention flag\> parameter to “n”.
 
  - Run gfs_validate_tranche_checksum.py with <asset file location> set to “gfs” and <asset-folder to process> set to the asset-folder type.
 
-Run gfs_validate_tranche_folder.py with the <gfs filenaming convention flag> parameter set to <n> for all the asset-folders types that exist in the tranche (this checks that all the asset-folders have been populated with at least one asset-file)
+Run gfs_validate_tranche_folder.py with the \<gfs filenaming convention flag\> parameter set to "n" for all the asset-folders types that exist in the tranche (this checks that all the asset-folders have been populated with at least one asset-file)
 
-Run gfs_validate_tranche_checksum.py with <asset file location> set to “gfs” and listing all the asset-folder types.
+Run gfs_validate_tranche_checksum.py with \<asset file location\> set to “gfs” and listing all the asset-folder types.
 
 If no errors are reported, it has now been established that all the asset-files have retained their fixity after being copied over from the legacy file location. However, if the requirement is to rename the asset-files so that they accord with the “GFS Filenaming Convention”, it is now necessary to delete all the checksum-files prior to the renaming because the names contained in the checksum-files need to match the names of the actual asset-files.
 
-Run gfs_create_or_delete_tranche_checksum_folder.py with the <action> parameter set to “delete_only_content_of_folder” and listing all the asset-folder types.
+Run gfs_create_or_delete_tranche_checksum_folder.py with the \<action\> parameter set to “delete_only_content_of_folder” and listing all the asset-folder types.
 
 Run gfs_rename_tranche_files.py for all the asset-folder types contained in the tranche.
 
-Run gfs_validate_tranche_folder.py with the <gfs filenaming convention flag> parameter set to “y” for all the asset-folder types contained in the tranche.
+Run gfs_validate_tranche_folder.py with the \<gfs filenaming convention flag\> parameter set to “y” for all the asset-folder types contained in the tranche.
 
 Run gfs_create_tranche_checksum_file.py with <asset file location> set to “gfs” and listing all the asset-folder types contained in the tranche.
 
@@ -97,17 +97,17 @@ Therefore, the following steps should be performed for each asset-folder type th
 
  - Run gfs_migrate_tranche_folder.py with <action> set to “test” (this flags up any asset-folder within a child-folder that will not be populated with any asset-files. If this is the case, the relevant entry in the "gfs.legacyPath" column of the tranche csv should be corrected)
 
- - Run gfs_create_tranche_checksum_file.py with <asset file location> set to “legacy” (this creates checksums in checksum-manifest-files in the checksum-folders that correspond to the content of the asset-files in the their legacy location).
+ - Run gfs_create_tranche_checksum_file.py with \<asset file location\> set to “legacy” (this creates checksums in checksum-manifest-files in the checksum-folders that correspond to the content of the asset-files in the their legacy location).
 
- - Run gfs_validate_tranche_checksum.py with <asset file location> set to “legacy”.
+ - Run gfs_validate_tranche_checksum.py with \<asset file location\> set to “legacy”.
 
- - Run gfs_migrate_tranche_folder.py with <action> set to “copy”.
+ - Run gfs_migrate_tranche_folder.py with \<action\> set to “copy”.
 
  - Run gfs_validate_tranche_folder.py for the asset-folder, setting the <gfs filenaming convention flag> parameter to “n”.
 
  - Run gfs_validate_tranche_checksum.py with <asset file location> set to “gfs” and <asset-folder to process> set to the asset-folder type.
 
-Run gfs_validate_tranche_folder.py with the <gfs filenaming convention flag> parameter set to "n" for all the asset-folders types that exist in the tranche (this will indicate any asset folders that have no asset-files in them so that you can judge whether this accords with expectations)
+Run gfs_validate_tranche_folder.py with the \<gfs filenaming convention flag\> parameter set to "n" for all the asset-folders types that exist in the tranche (this will indicate any asset folders that have no asset-files in them so that you can judge whether this accords with expectations)
 
 Run gfs_validate_tranche_checksum.py with <asset file location> set to “gfs” and listing all the asset-folder types (this will indicate any mismatches between the asset-files and their corresponding checksum-files).