Skip to content

Commit

Permalink
Fix/docs (#2506)
Browse files Browse the repository at this point in the history
* GITBOOK-394: updated env

* GITBOOK-395: Added module schema section

* GITBOOK-392: GHGP demo guide added

* GITBOOK-396: AMS II.G demo guide

* GITBOOK-391: Removal of  ‘\ backslaskes’ on documentations submitted by IEU

---------

Co-authored-by: prernaa.agarwal <[email protected]>
  • Loading branch information
simvalery and prernaadev01 authored Aug 1, 2023
1 parent 9a8e2a3 commit 011cc6e
Show file tree
Hide file tree
Showing 181 changed files with 412 additions and 95 deletions.
Binary file added docs/.gitbook/assets/0 (1).jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/0 (7).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/0 (8).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/0 (9).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/0.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/1 (10).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/1 (11).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/1 (5) (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/1 (5).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/1 (9).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/10 (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/10 (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/10 (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/10 (7).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/10 (8).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/10 (9).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/11 (5) (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/11 (5).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/11 (7).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/11 (8).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/11 (9).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/12 (1) (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/12 (1).png
Binary file added docs/.gitbook/assets/12 (6).png
Binary file added docs/.gitbook/assets/12 (7).png
Binary file added docs/.gitbook/assets/12 (8).png
Binary file modified docs/.gitbook/assets/12.png
Binary file added docs/.gitbook/assets/13 (1) (3).png
Binary file modified docs/.gitbook/assets/13 (1).png
Binary file modified docs/.gitbook/assets/13 (3).png
Binary file added docs/.gitbook/assets/13 (6).png
Binary file added docs/.gitbook/assets/13 (7).png
Binary file modified docs/.gitbook/assets/13.png
Binary file added docs/.gitbook/assets/14 (1) (2).png
Binary file modified docs/.gitbook/assets/14 (1).png
Binary file added docs/.gitbook/assets/14 (6).png
Binary file added docs/.gitbook/assets/14 (7).png
Binary file added docs/.gitbook/assets/14 (8).png
Binary file modified docs/.gitbook/assets/14.png
Binary file added docs/.gitbook/assets/15 (6) (1).png
Binary file added docs/.gitbook/assets/15 (6).png
Binary file added docs/.gitbook/assets/15 (7).png
Binary file added docs/.gitbook/assets/15 (8).png
Binary file modified docs/.gitbook/assets/15.png
Binary file added docs/.gitbook/assets/16 (1) (1) (1).png
Binary file modified docs/.gitbook/assets/16 (1) (1).png
Binary file modified docs/.gitbook/assets/16 (1).png
Binary file added docs/.gitbook/assets/16 (6).png
Binary file added docs/.gitbook/assets/16 (7).png
Binary file added docs/.gitbook/assets/16 (8).png
Binary file modified docs/.gitbook/assets/16.png
Binary file added docs/.gitbook/assets/17 (1) (3) (1).png
Binary file modified docs/.gitbook/assets/17 (1) (3).png
Binary file modified docs/.gitbook/assets/17 (1).png
Binary file added docs/.gitbook/assets/17 (5).png
Binary file added docs/.gitbook/assets/17 (6).png
Binary file added docs/.gitbook/assets/17 (7).png
Binary file modified docs/.gitbook/assets/17.png
Binary file added docs/.gitbook/assets/18 (1) (3).png
Binary file modified docs/.gitbook/assets/18 (1).png
Binary file added docs/.gitbook/assets/18 (6).png
Binary file added docs/.gitbook/assets/18 (7).png
Binary file added docs/.gitbook/assets/18 (8).png
Binary file modified docs/.gitbook/assets/18.png
Binary file added docs/.gitbook/assets/19 (1) (2).png
Binary file modified docs/.gitbook/assets/19 (1).png
Binary file added docs/.gitbook/assets/19 (6).png
Binary file added docs/.gitbook/assets/19 (7).png
Binary file added docs/.gitbook/assets/19 (8).png
Binary file modified docs/.gitbook/assets/19.png
Binary file added docs/.gitbook/assets/2 (10).png
Binary file added docs/.gitbook/assets/2 (7) (1).png
Binary file modified docs/.gitbook/assets/2 (7).png
Binary file added docs/.gitbook/assets/2 (8).png
Binary file added docs/.gitbook/assets/2 (9).png
Binary file modified docs/.gitbook/assets/2.png
Binary file modified docs/.gitbook/assets/20 (1) (1).png
Binary file modified docs/.gitbook/assets/20 (1).png
Binary file modified docs/.gitbook/assets/20 (3).png
Binary file added docs/.gitbook/assets/20 (4).png
Binary file modified docs/.gitbook/assets/20.png
Binary file added docs/.gitbook/assets/3 (10).png
Binary file added docs/.gitbook/assets/3 (5) (2).png
Binary file modified docs/.gitbook/assets/3 (5).png
Binary file added docs/.gitbook/assets/3 (8).png
Binary file added docs/.gitbook/assets/3 (9).png
Binary file modified docs/.gitbook/assets/3.png
Binary file added docs/.gitbook/assets/4 (4) (1).png
Binary file modified docs/.gitbook/assets/4 (4).png
Binary file added docs/.gitbook/assets/4 (7).png
Binary file added docs/.gitbook/assets/4 (8).png
Binary file added docs/.gitbook/assets/4 (9).png
Binary file modified docs/.gitbook/assets/4.png
Binary file added docs/.gitbook/assets/5 (7) (1).png
Binary file added docs/.gitbook/assets/5 (7).png
Binary file added docs/.gitbook/assets/5 (8).png
Binary file added docs/.gitbook/assets/5 (9).png
Binary file modified docs/.gitbook/assets/5.png
Binary file added docs/.gitbook/assets/6 (1) (4).png
Binary file modified docs/.gitbook/assets/6 (1).png
Binary file added docs/.gitbook/assets/6 (6).png
Binary file added docs/.gitbook/assets/6 (7).png
Binary file added docs/.gitbook/assets/6 (8).png
Binary file modified docs/.gitbook/assets/6.png
Binary file added docs/.gitbook/assets/7 (5) (2).png
Binary file modified docs/.gitbook/assets/7 (5).png
Binary file added docs/.gitbook/assets/7 (6).png
Binary file added docs/.gitbook/assets/7 (7).png
Binary file added docs/.gitbook/assets/7 (8).png
Binary file modified docs/.gitbook/assets/7.png
Binary file added docs/.gitbook/assets/8 (1) (4).png
Binary file modified docs/.gitbook/assets/8 (1).png
Binary file modified docs/.gitbook/assets/8 (4).png
Binary file added docs/.gitbook/assets/8 (7).png
Binary file added docs/.gitbook/assets/8 (8).png
Binary file modified docs/.gitbook/assets/8.png
Binary file modified docs/.gitbook/assets/9 (1) (3).png
Binary file modified docs/.gitbook/assets/9 (1).png
Binary file modified docs/.gitbook/assets/9 (2).png
Binary file modified docs/.gitbook/assets/9 (3).png
Binary file modified docs/.gitbook/assets/9.png
Binary file added docs/.gitbook/assets/image (1) (1) (6).png
Binary file modified docs/.gitbook/assets/image (1) (1).png
Binary file modified docs/.gitbook/assets/image (1).png
Binary file added docs/.gitbook/assets/image (2) (1) (2) (1).png
Binary file modified docs/.gitbook/assets/image (2) (1) (2).png
Binary file modified docs/.gitbook/assets/image (2) (1).png
Binary file modified docs/.gitbook/assets/image (2).png
Binary file added docs/.gitbook/assets/image (224).png
Binary file added docs/.gitbook/assets/image (225).png
Binary file added docs/.gitbook/assets/image (226).png
Binary file added docs/.gitbook/assets/image (227).png
Binary file added docs/.gitbook/assets/image (228).png
Binary file added docs/.gitbook/assets/image (229).png
Binary file added docs/.gitbook/assets/image (230).png
Binary file added docs/.gitbook/assets/image (231).png
Binary file added docs/.gitbook/assets/image (232).png
Binary file added docs/.gitbook/assets/image (233).png
Binary file added docs/.gitbook/assets/image (234).png
Binary file added docs/.gitbook/assets/image (235).png
Binary file added docs/.gitbook/assets/image (236).png
Binary file added docs/.gitbook/assets/image (237).png
Binary file added docs/.gitbook/assets/image (238).png
Binary file added docs/.gitbook/assets/image (239).png
Binary file added docs/.gitbook/assets/image (240).png
Binary file added docs/.gitbook/assets/image (241).png
Binary file added docs/.gitbook/assets/image (242).png
Binary file added docs/.gitbook/assets/image (243).png
Binary file added docs/.gitbook/assets/image (244).png
Binary file added docs/.gitbook/assets/image (245).png
Binary file added docs/.gitbook/assets/image (246).png
Binary file added docs/.gitbook/assets/image (247).png
Binary file added docs/.gitbook/assets/image (3) (6).png
Binary file modified docs/.gitbook/assets/image (3).png
Binary file added docs/.gitbook/assets/image (7) (6).png
Binary file modified docs/.gitbook/assets/image (7).png
Binary file modified docs/.gitbook/assets/image.png
2 changes: 2 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,8 @@
* [🏢 Carbon Emissions Measurement - GHG Corporate Standard Policy Guide](guardian/demo-guide/carbon-emissions/carbon-emissions-measurement-ghg-corporate-standard-policy-guide.md)
* [🏭 atma GHG Scope II Carbon Emission Policy](guardian/demo-guide/carbon-emissions/atma-ghg-scope-ii-carbon-emission-policy.md)
* [🏭 Carbon Development Mechanism (CDM) AMS-III.AR Policy](guardian/demo-guide/carbon-emissions/carbon-development-mechanism-cdm-ams-iii.ar-policy.md)
* [🏭 GHGP Corporate Standard](guardian/demo-guide/carbon-emissions/ghgp-corporate-standard.md)
* [🏨 CDM AMS II.G](guardian/demo-guide/carbon-emissions/cdm-ams-ii.g.md)
* [❓ FAQs](faqs/faqs.md)

***
Expand Down
44 changes: 6 additions & 38 deletions docs/guardian-in-production/api-architecture-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,16 @@ However, as with any technology, there are always opportunities for improvement.

Whether you are building a new API or looking to improve an existing one, the recommendations in this document will help the Guardian to build a more reliable, scalable, and maintainable API.

\


## 2. Web Proxy

As web applications grow in complexity, the need for a robust and scalable proxy server becomes increasingly important. While Nginx has been a popular choice for many years, Node.js Express with TypeScript has emerged as a powerful alternative due to its flexibility, scalability, and ease of customization.\

As web applications grow in complexity, the need for a robust and scalable proxy server becomes increasingly important. While Nginx has been a popular choice for many years, Node.js Express with TypeScript has emerged as a powerful alternative due to its flexibility, scalability, and ease of customization.

In this document, we will explore the benefits of migrating a proxy application from Nginx to Node.js Express with TypeScript. We will cover topics such as performance optimization, security enhancements, and customization of headers, requests, and responses.\


Whether you are looking to improve the scalability of your application or add new security layers, the migration to Node.js Express with TypeScript will provide you with the tools necessary to achieve your goals. By leveraging the power of TypeScript, you can write more maintainable code and take advantage of its type checking capabilities to catch errors early in the development process.\
In this document, we will explore the benefits of migrating a proxy application from Nginx to Node.js Express with TypeScript. We will cover topics such as performance optimization, security enhancements, and customization of headers, requests, and responses.

Whether you are looking to improve the scalability of your application or add new security layers, the migration to Node.js Express with TypeScript will provide you with the tools necessary to achieve your goals. By leveraging the power of TypeScript, you can write more maintainable code and take advantage of its type checking capabilities to catch errors early in the development process.

So, let's get started and see how we can migrate our proxy application to Node.js Express with TypeScript and unlock its full potential!



Why migrate?\
\
Here are some reasons why migrating a proxy application from Nginx to Node.js Express can be beneficial:
Expand Down Expand Up @@ -181,26 +173,16 @@ Node.js crypto module: This built-in Node.js module provides cryptographic funct
\
For some kinds of events due to their own criticality, it would be interesting to contain a recovery or a mechanism to rerun specific payloads, such as dead-letter resources to handle unsubscribed events or even to handle subscriptions that could not run properly. Many applications contain this kind of solution such us Google Pub/Sub, AWS SQS, and so on.

Recently we face a situation that leads some events in NATS to cause the TIMEOUT. In this situation, if we were in Production, we won’t be able to trigger these events again and all the messages would be lost.


Recently we face a situation that leads some events in NATS to cause the TIMEOUT. In this situation, if we were in Production, we won’t be able to trigger these events again and all the messages would be lost.\


The main idea of this topic would be to provide a strategy to manage and/or circumvent the situation. But after a lot of research, NATS has some benefits but for the blockchain context, it seems not to be the best approach. The suggestion to be prepared for all these upsetting events would be to migrate the current Message Broker. After some analyses, Kafka would fit better due to the fact that it contains more features that would enhance the whole ecosystem of the Guardian application.\

The main idea of this topic would be to provide a strategy to manage and/or circumvent the situation. But after a lot of research, NATS has some benefits but for the blockchain context, it seems not to be the best approach. The suggestion to be prepared for all these upsetting events would be to migrate the current Message Broker. After some analyses, Kafka would fit better due to the fact that it contains more features that would enhance the whole ecosystem of the Guardian application.

Migrating a message broker built on NATS to Kafka may be necessary for specific use cases where NATS' capabilities are insufficient. Kafka offers additional features such as message durability, fault tolerance, and scalability that may be critical for certain applications.



If your application requires high throughput and real-time processing of streaming data, Kafka's distributed streaming platform and its ability to handle millions of messages per second make it a strong candidate. Additionally, Kafka's built-in partitioning and replication features provide high availability and fault tolerance, ensuring that messages are not lost even in the case of node failures.



Furthermore, Kafka's support for message ordering within a partition and its ability to store messages on disk make it well-suited for use cases where message durability is critical, such as in a blockchain application.



However, it's important to note that migrating to Kafka may require additional development effort and expertise, as Kafka has a steeper learning curve and is a more complex system compared to NATS. Therefore, the decision to migrate should be made after carefully evaluating your specific requirements and use case.\


Expand All @@ -215,26 +197,12 @@ However, it's important to note that migrating to Kafka may require additional d
| Community | Growing community, but smaller than Kafka | Large and active community |
| Use cases | Ideal for high-performance, low-latency messaging scenarios | Ideal for real-time data processing, streaming, and messaging scenarios |

\


Now, about migrating to Kafka for a blockchain application where data loss is critical, there are a few factors to consider.



Firstly, blockchain applications typically require a high level of data integrity and durability, as the data stored on the blockchain is immutable and cannot be changed once it is added. This means that any loss of data could have serious consequences, so it is important to choose a messaging system that can provide the necessary level of durability.



While NATS is a high-performance messaging system, it does not provide message durability by default. This means that if a message is lost, it cannot be recovered, which could be problematic for a blockchain application where data loss is critical.

On the other hand, Kafka is designed to provide durability through the retention of messages. It stores messages on disk, and can be configured to replicate messages across multiple brokers to ensure that they are not lost. This makes Kafka a better choice for a blockchain application where data loss is critical.\

On the other hand, Kafka is designed to provide durability through the retention of messages. It stores messages on disk, and can be configured to replicate messages across multiple brokers to ensure that they are not lost. This makes Kafka a better choice for a blockchain application where data loss is critical.

That being said, it is important to note that Kafka is a more complex system than NATS, and requires some learning curve to get started with. Additionally, Kafka may not be necessary for all blockchain applications, depending on the specific use case and requirements. Therefore, it is important to carefully evaluate your needs and choose the messaging system that best fits your requirements.

\
\


\
2 changes: 0 additions & 2 deletions docs/guardian-in-production/monitoring-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,3 @@ These services are being scraped by Prometheus, which was defined to running her
A complete dashboard was created by default using the Grafana application to present interesting metrics. This dashboard can be accessed here once you have the Guardian application running -> [**http://localhost:9080**](http://localhost:9080/).

<figure><img src="../.gitbook/assets/220951740-45a57b4f-71f3-4c3f-ada9-1496c3e23535.png" alt=""><figcaption></figcaption></figure>

\
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ These roles are as follows:
\


<figure><img src="../../../.gitbook/assets/0.jpeg" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/0 (1).jpeg" alt=""><figcaption></figcaption></figure>

## **Policy Guide**

Expand Down Expand Up @@ -93,7 +93,7 @@ Certified Emission Reduction (CER) credits, each equivalent to one tonne of CO2.



<figure><img src="../../../.gitbook/assets/image (7).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (7) (6).png" alt=""><figcaption></figcaption></figure>
2. Enter the IPFS timestamp and select OK.

<figure><img src="../../../.gitbook/assets/image (14).png" alt=""><figcaption></figcaption></figure>
Expand Down Expand Up @@ -172,7 +172,7 @@ Certified Emission Reduction (CER) credits, each equivalent to one tonne of CO2.

21. Navigate back to the Administrator’s profile and select the “Mint” button.

<figure><img src="../../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (1) (1).png" alt=""><figcaption></figcaption></figure>

22. The status should now say “Minted”.

Expand Down
Loading

0 comments on commit 011cc6e

Please sign in to comment.