Merge pull request 'new' (!155) from dev_docs into development

Reviewed-on: #155
This commit is contained in:
mik-tf 2024-10-23 03:53:25 +00:00
commit db40adc03e

View File

@ -6,8 +6,6 @@
- [Installation](#installation) - [Installation](#installation)
- [MacOS or Linux](#macos-or-linux) - [MacOS or Linux](#macos-or-linux)
- [Windows](#windows) - [Windows](#windows)
- [Install Chocolatey](#install-chocolatey)
- [Install Mdbook](#install-mdbook)
- [Create a New Mdbook](#create-a-new-mdbook) - [Create a New Mdbook](#create-a-new-mdbook)
- [More Information](#more-information) - [More Information](#more-information)
@ -36,12 +34,11 @@ We introduce Mdbook and Hero Mdbook.
### Windows ### Windows
#### Install Chocolatey - Install Chocolatey
- To install Chocolatey on Windows, we follow the [official Chocolatey website](https://chocolatey.org/install) instructions.
To install Chocolatey on Windows, we follow the [official Chocolatey website](https://chocolatey.org/install) instructions. * Run PowerShell as Administrator
* Check if **Get-ExecutionPolicy** is restricted
* Run PowerShell as Administrator
* Check if **Get-ExecutionPolicy** is restricted
* ``` * ```
Get-ExecutionPolicy Get-ExecutionPolicy
``` ```
@ -49,17 +46,15 @@ To install Chocolatey on Windows, we follow the [official Chocolatey website](ht
* ``` * ```
Set-ExecutionPolicy AllSigned Set-ExecutionPolicy AllSigned
``` ```
* Install Chocolatey * Install Chocolatey
* ``` * ```
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1')) Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
``` ```
* Note: You might need to restart PowerShell to use Chocolatey * Note: You might need to restart PowerShell to use Chocolatey
- Install Mdbook
#### Install Mdbook - ```
choco install mdbook
``` ```
choco install mdbook
```
## Create a New Mdbook ## Create a New Mdbook
@ -78,7 +73,6 @@ choco install mdbook
## More Information ## More Information
- Update an mdbook on a GitHub repo - [Update an mdbook on a GitHub repo](https://manual.grid.tf/knowledge_base/collaboration/contribute.html)
- https://manual.grid.tf/knowledge_base/collaboration/contribute.html
- [Deploy a Hero Mdbook on Docker](./hero_mdbook_docker.md) - [Deploy a Hero Mdbook on Docker](./hero_mdbook_docker.md)
- [Create a Hero Mdbook](./hero_create_mdbook.md) - [Create a Hero Mdbook](./hero_create_mdbook.md)