diff --git a/Docs/ClientImplementation.md b/Docs/ClientImplementation.md index 90a07e9..52b2732 100644 --- a/Docs/ClientImplementation.md +++ b/Docs/ClientImplementation.md @@ -83,8 +83,6 @@ show a sample structure of file ```grouptrackcontainer.json```. ``` The default path to the container tracker is ```client/trackcontainers/grouptrackcontainer.json```. -### Note: -The group id will be auto-generated and will have its own prefix in the start which will mostly be ```grp```. -When a container is removed using the command. ```p2prc --rm --id ```. It will be automatically deleted -from the groups it exists in. - +> [!NOTE] +> The group id will be auto-generated and will have its own prefix in the start which will mostly be ```grp```. +> When a container is removed using the command. ```p2prc --rm --id ```. It will be automatically deleted from the groups it exists in. diff --git a/Docs/Installation.md b/Docs/Installation.md index 795ef64..a7525c1 100644 --- a/Docs/Installation.md +++ b/Docs/Installation.md @@ -232,12 +232,13 @@ This feature is still Under Development: - Generate Test Case Ansible file - ```make testcases``` - Enter inside plugin directory and run tests.
- **Note:** That docker needs to installed and needs to run without - sudo. Refer the section [Install Docker](#install-docker). - - ```cd plugin``` - - ```go test .``` + +> [!NOTE] +> That docker needs to installed and needs to run without +> sudo. Refer the section [Install Docker](#install-docker). +> - ```cd plugin``` +> - ```go test .``` --- ### Next Chapter: [Abstractions](Abstractions.md) - diff --git a/Docs/P2P.md b/Docs/P2P.md index 875c1ea..542a2b0 100644 --- a/Docs/P2P.md +++ b/Docs/P2P.md @@ -23,5 +23,5 @@ In this repository the P2P module has been designed from sratch at the point of - Taking to nodes behind NAT. [More about the implementation](NAT-Traversal)... -## Note: -If you are running in server mode it is recommended to use [DMZ](https://routerguide.net/when-and-how-to-setup-dmz-host-for-home-use/) to bypass the [NAT](https://en.wikipedia.org/wiki/Network_address_translation). +> [!NOTE] +> If you are running in server mode it is recommended to use [DMZ](https://routerguide.net/when-and-how-to-setup-dmz-host-for-home-use/) to bypass the [NAT](https://en.wikipedia.org/wiki/Network_address_translation). diff --git a/Docs/PluginImplementation.md b/Docs/PluginImplementation.md index 5975611..f454822 100644 --- a/Docs/PluginImplementation.md +++ b/Docs/PluginImplementation.md @@ -54,22 +54,23 @@ nodes to execute Ansible instructions. In this project this file needs to be set go code or binary will populate this file automatically with the appropriate information required to connect to local or remote containers. -#### Note: Add as exactly specified below -``` -all: - vars: - ansible_python_interpreter: /usr/bin/python3 // Path to your python 3 interpreter -main: - hosts: - host1: - // Note: These values will be automatically overwritten - // by the Go functions - ansible_host: 0.0.0.0 - ansible_port: 39269 - ansible_user: master - ansible_ssh_pass: password - ansible_sudo_pass: password -``` +> [!NOTE] +> Add as exactly specified below: +> ``` +>all: +> vars: +> ansible_python_interpreter: /usr/bin/python3 // Path to your python 3 interpreter +>main: +> hosts: +> host1: +> // Note: These values will be automatically overwritten +> // by the Go functions +> ansible_host: 0.0.0.0 +> ansible_port: 39269 +> ansible_user: master +> ansible_ssh_pass: password +> ansible_sudo_pass: password +>``` ## Ports.json The ```ports.json``` file is intended to mention the number of ports required diff --git a/README.md b/README.md index d74be67..6a810ee 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ -> **_NOTE:_** Fixing documentation to lastest changes ,If you have any questions setting up P2PRC either create an issue or send me an email (me AT akilan dot io). +> [!NOTE] +> Fixing documentation to latest changes. If you have any questions setting up P2PRC either [create an issue](https://github.com/Akilan1999/p2p-rendering-computation/issues/new/choose) or send me an email (me AT akilan dot io). > Currently HEAD is always intended to stay on a working state. It is recommended to always use HEAD in your go.mod file. +


p2prc @@ -160,4 +162,3 @@ or just providing feedback on new features to build or even just curious about [![Support Server](https://discordapp.com/api/guilds/854397492795277322/widget.png?style=banner2)](https://discord.gg/b4nRGTjYqy) [![Star History Chart](https://api.star-history.com/svg?repos=Akilan1999/p2p-rendering-computation&type=Date)](https://github.com/Gaurav-Gosain) - diff --git a/artwork/README.md b/artwork/README.md index a9f2bea..e0aeb4f 100644 --- a/artwork/README.md +++ b/artwork/README.md @@ -4,13 +4,11 @@ ## Pure HTML Version of the p2prc Logo :) ![p2prc Logo](https://user-images.githubusercontent.com/55647468/204634868-07e94b6d-65f5-4446-a11f-7a14f11edff9.png) -> Note: To change the size of the logo simply edit the CSS variable of `--size` under the `style` tag! +> [!NOTE] +> To change the size of the logo simply edit the CSS variable of `--size` under the `style` tag! --- ### Embedding the HTML as a `foreignObject` element inside an SVG directly ![](embed.svg) - - - diff --git a/server/docker/dockprom/README.md b/server/docker/dockprom/README.md index d237bee..9bb8602 100644 --- a/server/docker/dockprom/README.md +++ b/server/docker/dockprom/README.md @@ -99,7 +99,8 @@ The Docker Containers Dashboard shows key metrics for monitoring running contain * Container network inbound usage graph * Container network outbound usage graph -Note that this dashboard doesn't show the containers that are part of the monitoring stack. +> [!NOTE] +> This dashboard doesn't show the containers that are part of the monitoring stack. ***Monitor Services Dashboard*** diff --git a/server/docker/dockprom/helpers/aws/README.md b/server/docker/dockprom/helpers/aws/README.md index 1e88ca8..22ffc15 100644 --- a/server/docker/dockprom/helpers/aws/README.md +++ b/server/docker/dockprom/helpers/aws/README.md @@ -14,9 +14,9 @@ To get started on AWS ECS and EC2: - Copy prometheus.yml configuration present here to base prometheus configuration to enable EC2 service discovery - `docker compose up -d` -**Note**: -Set query.staleness-delta to 1m make metrics more realtime +> [!NOTE] +> Set query.staleness-delta to 1m make metrics more realtime ### TODO -- Add alerting rules based on ECS +- [ ] Add alerting rules based on ECS