Links to online documentation:

* Adding a help button on top of the chat, that links to the online documentation on frama.io.
* Replaced github.io documentation links by frama.io documentation.
* Adding links to the documentation in the diagnostic tool.
This commit is contained in:
John Livingston
2023-07-26 18:16:30 +02:00
parent 8db4f10584
commit 3fd6b9b563
12 changed files with 199 additions and 28 deletions

View File

@ -3,6 +3,7 @@ import { getProsodyConfig, getProsodyConfigContentForDiagnostic, getWorkingDir }
import { checkProsody, getProsodyAbout, testProsodyCorrectlyRunning } from '../prosody/ctl'
import { newResult, TestResult } from './utils'
import { getAPIKey } from '../apikey'
import { helpUrl } from '../../../shared/lib/help'
import * as fs from 'fs'
const got = require('got')
@ -190,7 +191,16 @@ export async function diagProsody (test: string, options: RegisterServerOptions)
if (testResult.ok === true) {
result.messages.push('API Prosody -> Peertube is OK')
} else {
result.messages.push('API Prosody -> Peertube is KO. Response was: ' + JSON.stringify(testResult))
result.messages.push({
level: 'error',
message: 'API Prosody -> Peertube is KO. Response was: ' + JSON.stringify(testResult),
help: {
text: 'Check the troubleshooting documentation.',
url: helpUrl({
page: 'documentation/installation/troubleshooting'
})
}
})
return result
}
} catch (error) {
@ -226,5 +236,6 @@ export async function diagProsody (test: string, options: RegisterServerOptions)
}
result.ok = true
result.next = 'everything-ok'
return result
}