Order of chapters in Handbook (#387)

* Docker build local * Preprod merge to main (#353) * Update README.md * Alternative chains support (#281) * add new smart contract addresses on goerli and mumbai networks, update settings * fix dependencies * update circle checks go version * update readme with chains list * test negative scenario * return goerli cobfig * remove console metamask error (#286) should fix #285 * Update README.md * add console logs on default accounts setup and on sign request * Test autodeploy flow (#290) * Update README.md * add console logs on default accounts setup and on sign request * Update dependabot.yml * Revised Handbook, added Formulas * Added SECURITY doc * Updated notice as per docs * Handbook on first login #311 --------- Co-authored-by: Oleg Lavrovsky <[email protected]> Co-authored-by: Afonina Tatiana <[email protected]>
ProxeusApp · Oct 18, 2023 · 559cdcb · 559cdcb
1 parent f24883d
commit 559cdcb
Show file tree

Hide file tree

Showing 8 changed files with 400 additions and 517 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,5 +1,7 @@
 version: 2
 updates:
+  target-branch: "preprod"
+
   # Maintain dependencies for Go
   - package-ecosystem: "gomod"
     directory: "/"

diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,7 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please use our public [Issue Tracker](https://github.com/ProxeusApp/proxeus-core/issues) to open improvement and bug tickets.
+
+If you find a **Security Issue** - a vulnerability that may affect live or testnet deployments please send your report privately to [email protected] - Please DO NOT file a public issue in this case.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -4,27 +4,26 @@
 
     - [Quick start](quickstart.md)
     - [User handbook](handbook.md)
+    - [Formulas guide](formulas.md)
+    - [F.A.Q.](faq.md)
 
 - Build and Run
 
+    - [Docker](build_docker.md)
     - [Build All](build_all.md)
     - [Configure Sever](configure.md)
-    - [Test](test.md)
     - [Front End Only](build_frontend.md)
     - [Back End Only](build_backend.md)
-    - [Docker](build_docker.md)
+    - [Test](test.md)
 
 - Development
 
     - [Software Architecture](architecture.md)
+    - [Components](components.md)
     - [Back End](backend.md)
     - [Front End](frontend.md)
-
-- Deployment
-
-    - [Components](components.md)
-    - [Docker](docker.md)
-    - [Smart Contract](contract_deployment.md)
+    - [Database](database.md)
+    - [Smart Contracts](contract_deployment.md)
 
 - API
 
@@ -33,18 +32,10 @@
         - [List All Workflows](api_list_all_workflows.md)
         - [Get Workflow Schema](api_get_workflow_schema.md)
         - [Execute Workflow](api_execute_workflow.md)
-
-
-- Workflow Extension
-
     - [External Workflow Nodes](external_workflow_nodes.md)
 
-- [Database](database.md)
-
 - [Contributing](contributing.md)
     - [Code of Conduct](code_of_conduct.md)
     - [Coding Style](coding_style.md)
 
-- [FAQ](faq.md)
-
 - [License](license.md)
diff --git a/docs/build_docker.md b/docs/build_docker.md
@@ -21,7 +21,7 @@ Please refer to the `docker-compose.yml` file to learn how to configure a Proxeu
 If you want to use a Docker image to build your server (for example, when you are not on a Linux machine or have a newer version of GLIBC than is supported in production), compile as follows:
 
 ```
-BUILD_WITH_DOCKER=true make init server-docker
+BUILD_WITH_DOCKER=true make init ui server-docker build-docker
 docker build .
 ```
 
@@ -42,7 +42,11 @@ docker-compose restart
 This will build the proxeus-core image based on your current project and use a deployed image
 for the document service.
 
-## Using Docker for the build
+## Tips
+
+Having an issue with Go? Make sure it's in your path, e.g.:
+
+`export PATH=$PATH:/usr/local/go/bin`
 
 If you're having trouble, try a clean full Docker build, specifying each of the configuration files:
 

diff --git a/docs/faq.md b/docs/faq.md
@@ -1,4 +1,4 @@
-# FAQ
+# Frequently Asked Questions
 
 To see new tips from the community, or if you have other questions, please visit our [Community Discussions](https://github.com/orgs/ProxeusApp/discussions).
 
@@ -7,12 +7,14 @@ To see new tips from the community, or if you have other questions, please visit
 **Q:** Can I build it on on Windows?
 
 **A:** There's no support for Windows yet; the whole init, build system has been tested on Linux and Mac only.
-##
+
+---
 
 **Q:** I'm getting an error when trying to run the frontend.
 
 **A:** Make sure you have NodeJS v8 and yarn 1.12. It hasn't been tested with superior versions yet.
-##
+
+---
 
 ## Settings
 
@@ -21,11 +23,12 @@ To see new tips from the community, or if you have other questions, please visit
 **A:** Yes, pretty much all the are changeable through the Internationalization settings. A SUPERADMIN or higher user can change that.
 That menu item should be shown on the sidebar in the backend or under `/admin/i18n`
 
-##
+---
 
 ## Forms
 
 **Q:** Why the name field is red?
 
 **A:** Components need to be unique and only a-z, A-Z, 0-9 is allowed. Do not use special characters and spaces for the naming of components.
-##
+
+---