Update URL to docs page for migrating and reference .boardarchive (#4043)

* chore: update docs URL for import/export/migrate

* chore: reference `.boardarchive` in import scripts & READMEs
This commit is contained in:
Paul Esch-Laurent 2022-10-19 14:33:06 -05:00 committed by GitHub
parent 38eaf5344e
commit 42ddbbdd69
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 23 additions and 23 deletions

View File

@ -5,8 +5,8 @@ This node app converts an Asana json archive into a Focalboard archive. To use:
2. Save it locally, e.g. to `asana.json` 2. Save it locally, e.g. to `asana.json`
3. Run `npm install` from within `focalboard/webapp` 3. Run `npm install` from within `focalboard/webapp`
4. Run `npm install` from within `focalboard/import/asana` 4. Run `npm install` from within `focalboard/import/asana`
5. Run `npx ts-node importAsana.ts -i <asana.json> -o archive.focalboard` 5. Run `npx ts-node importAsana.ts -i <asana.json> -o archive.boardarchive`
6. In Focalboard, click `Settings`, then `Import archive` and select `archive.focalboard` 6. In Focalboard, click `Settings`, then `Import archive` and select `archive.boardarchive`
## Import scope ## Import scope

View File

@ -34,7 +34,7 @@ function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2)) const args: minimist.ParsedArgs = minimist(process.argv.slice(2))
const inputFile = args['i'] const inputFile = args['i']
const outputFile = args['o'] || 'archive.focalboard' const outputFile = args['o'] || 'archive.boardarchive'
if (!inputFile) { if (!inputFile) {
showHelp() showHelp()
@ -184,7 +184,7 @@ function convert(input: Asana): [Board[], Block[]] {
} }
function showHelp() { function showHelp() {
console.log('import -i <input.json> -o [output.focalboard]') console.log('import -i <input.json> -o [output.boardarchive]')
exit(1) exit(1)
} }

View File

@ -6,8 +6,8 @@ This node app converts a Jira xml export into a Focalboard archive. To use:
3. Save it locally, e.g. to `jira_export.xml` 3. Save it locally, e.g. to `jira_export.xml`
4. Run `npm install` from within `focalboard/webapp` 4. Run `npm install` from within `focalboard/webapp`
5. Run `npm install` from within `focalboard/import/jira` 5. Run `npm install` from within `focalboard/import/jira`
6. Run `npx ts-node importJira.ts -i <path-to-jira.xml> -o archive.focalboard` (also from within `focalboard/import/jira`) 6. Run `npx ts-node importJira.ts -i <path-to-jira.xml> -o archive.boardarchive` (also from within `focalboard/import/jira`)
7. In Focalboard, click `Settings`, then `Import archive` and select `archive.focalboard` 7. In Focalboard, click `Settings`, then `Import archive` and select `archive.boardarchive`
## Import scope and known limitations ## Import scope and known limitations

View File

@ -8,7 +8,7 @@ async function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2)) const args: minimist.ParsedArgs = minimist(process.argv.slice(2))
const inputFile = args['i'] const inputFile = args['i']
const outputFile = args['o'] || 'archive.focalboard' const outputFile = args['o'] || 'archive.boardarchive'
return run(inputFile, outputFile) return run(inputFile, outputFile)
} }

View File

@ -237,7 +237,7 @@ function optionForPropertyValue(cardProperty: IPropertyTemplate, propertyValue:
} }
function showHelp() { function showHelp() {
console.log('import -i <input.xml> -o [output.focalboard]') console.log('import -i <input.xml> -o [output.boardarchive]')
exit(1) exit(1)
} }

View File

@ -4,10 +4,10 @@ This node app converts data from a Nextcloud Server with the [app Deck](https://
1. Run `npm install` from within `focalboard/webapp` 1. Run `npm install` from within `focalboard/webapp`
2. Run `npm install` from within `focalboard/import/nextcloud-deck` 2. Run `npm install` from within `focalboard/import/nextcloud-deck`
3. Run `npx ts-node importDeck.ts -o archive.focalboard` (also from within `focalboard/import/nextcloud-deck`) 3. Run `npx ts-node importDeck.ts -o archive.boardarchive` (also from within `focalboard/import/nextcloud-deck`)
1. Enter URL and credentials (can also be provided via cli arguments) 1. Enter URL and credentials (can also be provided via cli arguments)
2. Enter ID of the board to convert 2. Enter ID of the board to convert
4. In Focalboard, click `Settings`, then `Import archive` and select `archive.focalboard` 4. In Focalboard, click `Settings`, then `Import archive` and select `archive.boardarchive`
## Import scope ## Import scope

View File

@ -47,7 +47,7 @@ async function main() {
const password = args['p'] ?? readline.question('Password: ', {hideEchoBack: true}) const password = args['p'] ?? readline.question('Password: ', {hideEchoBack: true})
const boardIdString = args['b'] const boardIdString = args['b']
const outputFile = args['o'] || 'archive.focalboard' const outputFile = args['o'] || 'archive.boardarchive'
// Create Client // Create Client
const deckClient = new NextcloudDeckClient({auth: {username, password}, url}) const deckClient = new NextcloudDeckClient({auth: {username, password}, url})

View File

@ -6,8 +6,8 @@ This node app converts a Notion CSV and markdown export into a Focalboard archiv
3. Save it locally, and unzip the folder e.g. to `notion-export` 3. Save it locally, and unzip the folder e.g. to `notion-export`
4. Run `npm install` from within `focalboard/webapp` 4. Run `npm install` from within `focalboard/webapp`
5. Run `npm install` from within `focalboard/import/notion` 5. Run `npm install` from within `focalboard/import/notion`
6. Run `npx ts-node importNotion.ts -i <path to the notion-export folder> -o archive.focalboard` 6. Run `npx ts-node importNotion.ts -i <path to the notion-export folder> -o archive.boardarchive`
7. In Focalboard, click `Settings`, then `Import archive` and select `archive.focalboard` 7. In Focalboard, click `Settings`, then `Import archive` and select `archive.boardarchive`
## Import scope ## Import scope

View File

@ -35,7 +35,7 @@ async function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2)) const args: minimist.ParsedArgs = minimist(process.argv.slice(2))
const inputFolder = args['i'] const inputFolder = args['i']
const outputFile = args['o'] || 'archive.focalboard' const outputFile = args['o'] || 'archive.boardarchive'
if (!inputFolder) { if (!inputFolder) {
showHelp() showHelp()
@ -217,7 +217,7 @@ function convert(input: any[], title: string): [Board[], Block[]] {
} }
function showHelp() { function showHelp() {
console.log('import -i <input.json> -o [output.focalboard]') console.log('import -i <input.json> -o [output.boardarchive]')
exit(1) exit(1)
} }

View File

@ -8,5 +8,5 @@ This node app converts a Todoist json archive into a Focalboard archive. To use:
1. Note the name and location of the downloaded *json* file. 1. Note the name and location of the downloaded *json* file.
3. Run `npm install` from within `focalboard/webapp` 3. Run `npm install` from within `focalboard/webapp`
4. Run `npm install` from within `focalboard/import/todoist` 4. Run `npm install` from within `focalboard/import/todoist`
5. Run `npx ts-node importTodoist.ts -i <path-to-todoist.json> -o archive.focalboard` (also from within `focalboard/import/todoist`) 5. Run `npx ts-node importTodoist.ts -i <path-to-todoist.json> -o archive.boardarchive` (also from within `focalboard/import/todoist`)
6. In Focalboard, click `Settings`, then `Import archive` and select `archive.focalboard` 6. In Focalboard, click `Settings`, then `Import archive` and select `archive.boardarchive`

View File

@ -42,7 +42,7 @@ function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2)) const args: minimist.ParsedArgs = minimist(process.argv.slice(2))
const inputFile = args['i'] const inputFile = args['i']
const outputFile = args['o'] || 'archive.focalboard' const outputFile = args['o'] || 'archive.boardarchive'
if (!inputFile) { if (!inputFile) {
showHelp() showHelp()

View File

@ -6,8 +6,8 @@ This node app converts a Trello json archive into a Focalboard archive. To use:
3. Save it locally, e.g. to `trello.json` 3. Save it locally, e.g. to `trello.json`
4. Run `npm install` from within `focalboard/webapp` 4. Run `npm install` from within `focalboard/webapp`
5. Run `npm install` from within `focalboard/import/trello` 5. Run `npm install` from within `focalboard/import/trello`
6. Run `npx ts-node importTrello.ts -i <path-to-trello.json> -o archive.focalboard` (also from within `focalboard/import/trello`) 6. Run `npx ts-node importTrello.ts -i <path-to-trello.json> -o archive.boardarchive` (also from within `focalboard/import/trello`)
7. In Focalboard, click `Settings`, then `Import archive` and select `archive.focalboard` 7. In Focalboard, click `Settings`, then `Import archive` and select `archive.boardarchive`
## Import scope ## Import scope

View File

@ -35,7 +35,7 @@ function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2)) const args: minimist.ParsedArgs = minimist(process.argv.slice(2))
const inputFile = args['i'] const inputFile = args['i']
const outputFile = args['o'] || 'archive.focalboard' const outputFile = args['o'] || 'archive.boardarchive'
if (!inputFile) { if (!inputFile) {
showHelp() showHelp()
@ -169,7 +169,7 @@ function convert(input: Trello): [Board[], Block[]] {
} }
function showHelp() { function showHelp() {
console.log('import -i <input.json> -o [output.focalboard]') console.log('import -i <input.json> -o [output.boardarchive]')
exit(1) exit(1)
} }

View File

@ -39,7 +39,7 @@ class Constants {
static readonly versionString = '7.5.0' static readonly versionString = '7.5.0'
static readonly versionDisplayString = 'Nov 2022' static readonly versionDisplayString = 'Nov 2022'
static readonly archiveHelpPage = 'https://docs.mattermost.com/boards/data-and-archives.html' static readonly archiveHelpPage = 'https://docs.mattermost.com/boards/migrate-to-boards.html'
static readonly imports = [ static readonly imports = [
{ {
id: 'trello', id: 'trello',