diff --git a/Projects/Superalgos/Schemas/Docs-Topics/app-commands-errors-001-app-error-contribution-not-sent.json b/Projects/Superalgos/Schemas/Docs-Topics/app-commands-errors-001-app-error-contribution-not-sent.json new file mode 100644 index 000000000..c56501b93 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/app-commands-errors-001-app-error-contribution-not-sent.json @@ -0,0 +1,16 @@ +{ + "topic": "App Commands Errors", + "pageNumber": "1", + "type": "App Error Contribution Not Sent", + "definition": { + "text": "There was a problmen trying to send your contribution to your fork of the Superalgos repository.", + "updated": 1609859551082 + }, + "paragraphs": [ + { + "style": "Text", + "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode. 2", + "updated": 1609860582103 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/app-commands-errors-002-app-error-github-credentials-missing.json b/Projects/Superalgos/Schemas/Docs-Topics/app-commands-errors-002-app-error-github-credentials-missing.json new file mode 100644 index 000000000..8bd36f3d2 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/app-commands-errors-002-app-error-github-credentials-missing.json @@ -0,0 +1,70 @@ +{ + "topic": "App Commands Errors", + "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 + }, + "paragraphs": [ + { + "style": "Anchor", + "text": "Anchor Github Credentials Missing", + "updated": 1609855373585 + }, + { + "style": "Error", + "text": "Github Crendentials are Missing. Please solve this issue and try again." + }, + { + "style": "Text", + "text": "At the root folder of Superalgos, you will need to create a JSON file called Github.json. Use simple text editor like notepad and configure there your Github credentials. You can copy and paste the following template, replacing the dummy strings with your actual user name and password.", + "updated": 1609856366366 + }, + { + "style": "Title", + "text": "Github File Template", + "updated": 1609856386094 + }, + { + "style": "Javascript", + "text": "{\n \"user\": \"Your Github.com Username\",\n \"password\": \"Your Github.com Password\"\n \"repository\": \"\"\n }", + "updated": 1609857106444 + }, + { + "style": "Title", + "text": "Properties", + "updated": 1609857199167 + }, + { + "style": "List", + "text": "user: Your Github.com Username." + }, + { + "style": "List", + "text": "parrword: Your Github.com Password." + }, + { + "style": "List", + "text": "repository: The URL of your Superalgos fork." + }, + { + "style": "Title", + "text": "Example" + }, + { + "style": "Javascript", + "text": "{\n \"user\": \"john-smith\",\n \"password\": \"john123$\"\n \"repository\": \"github.com/john-smith/Superalgos\"\n }", + "updated": 1609857447825 + }, + { + "style": "Note", + "text": "Don't worry, your crendentials will not be uploaded to the repository because the file Github.json is listed at the .gitignore file, so it will be ignored and will only be at your local computer." + }, + { + "style": "Important", + "text": "The system will use your credentials only to execute a git push command pointing to your Superalgos repository fork, in order to upload all the changes you made to Docs Pages.", + "updated": 1609856824492 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/app-commands-messages-001-app-message-contribution-succeed.json b/Projects/Superalgos/Schemas/Docs-Topics/app-commands-messages-001-app-message-contribution-succeed.json new file mode 100644 index 000000000..136031d48 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/app-commands-messages-001-app-message-contribution-succeed.json @@ -0,0 +1,14 @@ +{ + "topic": "App Commands Messages", + "pageNumber": "1", + "type": "App Message Contribution Succeed", + "definition": { + "text": "Write here a summary for this topic page." + }, + "paragraphs": [ + { + "style": "Text", + "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-search-engine.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-search-engine.json new file mode 100644 index 000000000..a1febdf41 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-search-engine.json @@ -0,0 +1,16 @@ +{ + "topic": "Docs Basics", + "pageNumber": "17", + "type": "Docs Search Engine", + "definition": { + "text": "The Docs contains a search engine that allows users to search through the collection of pages.\n", + "updated": 1609784533352 + }, + "paragraphs": [ + { + "style": "Text", + "text": "The search engine builds a Docs Search Engine Index that is later used to find the phrases typed by users at the search box.", + "updated": 1609784587544 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine-index.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine-index.json new file mode 100644 index 000000000..ecc83f62b --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine-index.json @@ -0,0 +1,16 @@ +{ + "topic": "Docs Basics", + "pageNumber": "18", + "type": "Docs Search Engine Index", + "definition": { + "text": "The Docs Search Engine builds an in-memory index that contains all the phrases of all Docs Pages, plus the name, type, config and code of all nodes of the current Workspace.", + "updated": 1609784383995 + }, + "paragraphs": [ + { + "style": "Text", + "text": "This index is built when the UI is launched, and rebuilt when users executes the docs.reindex command or they load a new workspace.", + "updated": 1609784471513 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-001-docs-message-saving-succed.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-001-docs-message-saving-succeed.json similarity index 91% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-001-docs-message-saving-succed.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-001-docs-message-saving-succeed.json index 9deeb3fce..f049e5a3b 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-001-docs-message-saving-succed.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-001-docs-message-saving-succeed.json @@ -1,7 +1,7 @@ { "topic": "Docs Commands Messages", "pageNumber": "1", - "type": "Docs Message Saving Succed", + "type": "Docs Message Saving Succeed", "definition": { "text": "The docs.save command you executed was successful and all changes have been saved at the Superalgos Client.", "updated": 1609783244197 diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-002-docs-message-reindexing-succeed.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-002-docs-message-reindexing-succeed.json new file mode 100644 index 000000000..b2e1b071f --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-002-docs-message-reindexing-succeed.json @@ -0,0 +1,16 @@ +{ + "topic": "Docs Commands Messages", + "pageNumber": "2", + "type": "Docs Message Reindexing Succeed", + "definition": { + "text": "The docs.reindex command you executed succesfully rebuilt the Docs Search Engine Index.", + "updated": 1609783396612 + }, + "paragraphs": [ + { + "style": "Success", + "text": "The index was rebuilt and now includes all the latest changes you have made since you open the UI or since the last time you executed the docs.reindex command. That means that new content created now should affect the search results. Also, changes in the Workspace have been applied to the index too.", + "updated": 1609783508213 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-003-docs-message-deleting-succeed.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-003-docs-message-deleting-succeed.json new file mode 100644 index 000000000..d24e74863 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-003-docs-message-deleting-succeed.json @@ -0,0 +1,16 @@ +{ + "topic": "Docs Commands Messages", + "pageNumber": "3", + "type": "Docs Message Deleting Succeed", + "definition": { + "text": "The docs.delete command you executed successfuly delete the page you requested.", + "updated": 1609783558007 + }, + "paragraphs": [ + { + "style": "Success", + "text": "The page was removed from the in-memory collection of pages, but it is still indexed at the Docs Search Engine Index, and it still exist on disk. To remove it from the index you need to execute docs.reindex and to remove it from disk, you need to execute docs.save. ", + "updated": 1609783652507 + } + ] +} \ No newline at end of file