Merge pull request #322 from Luis-Fernando-Molina/in-app-documentation

Contribution to Superalgos
This commit is contained in:
Luis Fernando Molina authored and GitHub committed 2021-01-06 14:14:03 +01:00
commit 0246504d92
5 files changed
+83 -16

No files matched your search

+20 -11
View File
@@ -527,7 +527,9 @@ exports.newHttpInterface = function newHttpInterface(WEB_SERVER, DATA_FILE_SERVE
case 'Contribute': {
try {
const commitMessage = unescape(requestParameters[3])
const username = unescape(requestParameters[4])
const token = unescape(requestParameters[5])
contribute()
async function contribute() {
@@ -552,7 +554,6 @@ exports.newHttpInterface = function newHttpInterface(WEB_SERVER, DATA_FILE_SERVE
async function doGithub() {
const token = ""
const { Octokit } = require("@octokit/rest")
const octokit = new Octokit({
@@ -562,23 +563,31 @@ exports.newHttpInterface = function newHttpInterface(WEB_SERVER, DATA_FILE_SERVE
const repo = 'Superalgos'
const owner = 'Superalgos'
const head = 'Luis-Fernando-Molina:in-app-documentation'
const head = username + ':in-app-documentation'
const base = 'in-app-documentation'
const title = 'Contribution to Superalgos'
await octokit.pulls.create({
owner,
repo,
title,
head,
base,
});
try {
await octokit.pulls.create({
owner,
repo,
title,
head,
base,
});
} catch (err) {
if (err.stack.indexOf('A pull request already exists') <0) {
throw(err)
}
}
}
} catch (err) {
console.log('[ERROR] httpInterface -> App -> Contribute -> Method call produced an error.')
console.log('[ERROR] httpInterface -> App -> Contribute -> err.stack = ' + err.stack)
console.log('[ERROR] httpInterface -> App -> Contribute -> Params Received = ' + requestParameters[3])
console.log('[ERROR] httpInterface -> App -> Contribute -> commitMessage = ' + commitMessage)
console.log('[ERROR] httpInterface -> App -> Contribute -> username = ' + username)
console.log('[ERROR] httpInterface -> App -> Contribute -> token = ' + token)
let error = {
result: 'Fail Because',
@@ -0,0 +1,36 @@
{
"type": "The Docs Explained",
"definition": {
"text": "This book will walk you through everything you need to know about the Docs.",
"updated": 1609762580891
},
"paragraphs": [
{
"style": "Chapter",
"text": "Superalgos->I->Docs Basics->Read Chapter I to learn the basics concepts. They are the foundation that will let you understand the commands and styles explained later in this book.",
"updated": 1609763076399
},
{
"style": "Chapter",
"text": "Superalgos->II->Docs Commands->The Docs include a powerful command line interface that allows you to quickly fire commands from the search box. Dive into Chapter II to learn the details of each available command.",
"updated": 1609763122458
},
{
"style": "Chapter",
"text": "Superalgos->III->Docs Commands Errors"
},
{
"style": "Chapter",
"text": "Superalgos->IV->Docs Commands Messages",
"updated": 1609783744261
},
{
"style": "Chapter",
"text": "Superalgos->V->Docs Paragraph Styles"
},
{
"style": "Chapter",
"text": "Superalgos->VI->Docs Context Menu Actions"
}
]
}
@@ -80,4 +80,4 @@
"text": "lineDash is used to turn the border into a dashed-line; the first value corresponds to the length of the dash while the second value defines the length of the space."
}
]
}
}
@@ -3,8 +3,8 @@
"pageNumber": "2",
"type": "App Error Github Credentials Missing",
"definition": {
"text": "In order to manage contributions from within the app, you first need to provide your Github.com credentials so that we can get authenticated when pushing your changes to the remote repository.",
"updated": 1609855182001
"text": "In order to manage contributions from within the app, you first need to provide your Github.com credentials so that we can get authenticated when pushing your changes to the remote repository. 3",
"updated": 1609938644926
},
"paragraphs": [
{
@@ -31,12 +31,34 @@ function newSuperalgosDocsCommmandInterface() {
}
if (UI.projects.superalgos.spaces.docsSpace.commandInterface.command.indexOf('App.Contribute') !== 0 && UI.projects.superalgos.spaces.docsSpace.commandInterface.command.indexOf('app.contribute') !== 0) { return }
/* Set up the commit message */
let message = UI.projects.superalgos.spaces.docsSpace.commandInterface.command.trim().substring(UI.projects.superalgos.spaces.docsSpace.commandInterface.command.indexOf(' ') + 1, UI.projects.superalgos.spaces.docsSpace.commandInterface.command.length)
if (message.toLowerCase() === 'app.contribute') {
message = 'This is my contribution to Superalgos'
}
}
httpRequest(undefined, 'App/Contribute/' + message, onResponse)
/* Find the Username and Password */
let apisNode = UI.projects.superalgos.spaces.designSpace.workspace.getHierarchyHeadsByType('APIs')
if (apisNode === undefined) {
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Error Github Credentials Missing', 'Anchor Github Credentials Missing')
return true
}
if (apisNode.githubAPI === undefined) {
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Error Github Credentials Missing', 'Anchor Github Credentials Missing')
return true
}
let config = JSON.parse(apisNode.githubAPI.config)
if (config.username === undefined || config.username === "") {
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Error Github Credentials Missing', 'Anchor Github Credentials Missing')
return true
}
if (config.token === undefined || config.token === "") {
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Error Github Credentials Missing', 'Anchor Github Credentials Missing')
return true
}
httpRequest(undefined, 'App/Contribute/' + message + '/' + config.username + '/' + config.token, onResponse)
return true
function onResponse(err, data) {