Skip to content

Commit

Permalink
Update URL to docs page for migrating and reference .boardarchive (m…
Browse files Browse the repository at this point in the history
…attermost-community#4043)

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

* chore: reference `.boardarchive` in import scripts & READMEs
  • Loading branch information
Pinjasaur authored Oct 19, 2022
1 parent 38eaf53 commit 42ddbbd
Show file tree
Hide file tree
Showing 14 changed files with 23 additions and 23 deletions.
4 changes: 2 additions & 2 deletions import/asana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
3. Run `npm install` from within `focalboard/webapp`
4. Run `npm install` from within `focalboard/import/asana`
5. Run `npx ts-node importAsana.ts -i <asana.json> -o archive.focalboard`
6. In Focalboard, click `Settings`, then `Import archive` and select `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.boardarchive`

## Import scope

Expand Down
4 changes: 2 additions & 2 deletions import/asana/importAsana.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2))

const inputFile = args['i']
const outputFile = args['o'] || 'archive.focalboard'
const outputFile = args['o'] || 'archive.boardarchive'

if (!inputFile) {
showHelp()
Expand Down Expand Up @@ -184,7 +184,7 @@ function convert(input: Asana): [Board[], Block[]] {
}

function showHelp() {
console.log('import -i <input.json> -o [output.focalboard]')
console.log('import -i <input.json> -o [output.boardarchive]')
exit(1)
}

Expand Down
4 changes: 2 additions & 2 deletions import/jira/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
4. Run `npm install` from within `focalboard/webapp`
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`)
7. In Focalboard, click `Settings`, then `Import archive` and select `archive.focalboard`
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.boardarchive`

## Import scope and known limitations

Expand Down
2 changes: 1 addition & 1 deletion import/jira/importJira.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ async function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2))

const inputFile = args['i']
const outputFile = args['o'] || 'archive.focalboard'
const outputFile = args['o'] || 'archive.boardarchive'

return run(inputFile, outputFile)
}
Expand Down
2 changes: 1 addition & 1 deletion import/jira/jiraImporter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ function optionForPropertyValue(cardProperty: IPropertyTemplate, propertyValue:
}

function showHelp() {
console.log('import -i <input.xml> -o [output.focalboard]')
console.log('import -i <input.xml> -o [output.boardarchive]')
exit(1)
}

Expand Down
4 changes: 2 additions & 2 deletions import/nextcloud-deck/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
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)
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

Expand Down
2 changes: 1 addition & 1 deletion import/nextcloud-deck/importDeck.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ async function main() {
const password = args['p'] ?? readline.question('Password: ', {hideEchoBack: true})
const boardIdString = args['b']

const outputFile = args['o'] || 'archive.focalboard'
const outputFile = args['o'] || 'archive.boardarchive'

// Create Client
const deckClient = new NextcloudDeckClient({auth: {username, password}, url})
Expand Down
4 changes: 2 additions & 2 deletions import/notion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
4. Run `npm install` from within `focalboard/webapp`
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`
7. In Focalboard, click `Settings`, then `Import archive` and select `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.boardarchive`

## Import scope

Expand Down
4 changes: 2 additions & 2 deletions import/notion/importNotion.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ async function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2))

const inputFolder = args['i']
const outputFile = args['o'] || 'archive.focalboard'
const outputFile = args['o'] || 'archive.boardarchive'

if (!inputFolder) {
showHelp()
Expand Down Expand Up @@ -217,7 +217,7 @@ function convert(input: any[], title: string): [Board[], Block[]] {
}

function showHelp() {
console.log('import -i <input.json> -o [output.focalboard]')
console.log('import -i <input.json> -o [output.boardarchive]')
exit(1)
}

Expand Down
4 changes: 2 additions & 2 deletions import/todoist/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3. Run `npm install` from within `focalboard/webapp`
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`)
6. In Focalboard, click `Settings`, then `Import archive` and select `archive.focalboard`
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.boardarchive`
2 changes: 1 addition & 1 deletion import/todoist/importTodoist.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2))

const inputFile = args['i']
const outputFile = args['o'] || 'archive.focalboard'
const outputFile = args['o'] || 'archive.boardarchive'

if (!inputFile) {
showHelp()
Expand Down
4 changes: 2 additions & 2 deletions import/trello/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
4. Run `npm install` from within `focalboard/webapp`
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`)
7. In Focalboard, click `Settings`, then `Import archive` and select `archive.focalboard`
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.boardarchive`

## Import scope

Expand Down
4 changes: 2 additions & 2 deletions import/trello/importTrello.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function main() {
const args: minimist.ParsedArgs = minimist(process.argv.slice(2))

const inputFile = args['i']
const outputFile = args['o'] || 'archive.focalboard'
const outputFile = args['o'] || 'archive.boardarchive'

if (!inputFile) {
showHelp()
Expand Down Expand Up @@ -169,7 +169,7 @@ function convert(input: Trello): [Board[], Block[]] {
}

function showHelp() {
console.log('import -i <input.json> -o [output.focalboard]')
console.log('import -i <input.json> -o [output.boardarchive]')
exit(1)
}

Expand Down
2 changes: 1 addition & 1 deletion webapp/src/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ class Constants {
static readonly versionString = '7.5.0'
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 = [
{
id: 'trello',
Expand Down

0 comments on commit 42ddbbd

Please sign in to comment.