Giter Club home page Giter Club logo

phala-wiki-next's Introduction

Phala Network

Doks

Phala Wiki

The go to source for your Phala documentation.

GitHub GitHub release (latest SemVer including pre-releases) GitHub Workflow Status (branch) Netlify

Website

Phala Wiki

Requirements

The phala documentation is build on "Doks". Doks uses npm to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts:

  • Download and install Node.js (it includes npm) for your platform.

1. To Contribute Clone this Repoitory

git clone https://github.com/Phala-Network/phala-wiki-next.git my-doks-site && cd my-doks-site

2. Install dependencies

npm install

3. Start development server

npm run start

Other commands

Doks comes with commands for common tasks.

Documentation

Communities

phala-wiki-next's People

Contributors

shelvenzhou avatar hauni97 avatar doyleguo avatar limichange avatar tolak avatar hashwarlock avatar doylegxd avatar toldyaonce avatar dependabot[bot] avatar h4x3rotab avatar kvinwang avatar darknight7 avatar kingsleydon avatar kureus avatar krhougs avatar arnobase avatar tenheadedlion avatar jasl avatar leechael avatar skysummerice avatar zozyo avatar

Stargazers

 avatar nilspore avatar  avatar 苏格 avatar chucvv avatar  avatar  avatar  avatar

Watchers

James Cloos avatar  avatar  avatar  avatar  avatar  avatar Paco Yang avatar Leona Yang avatar  avatar  avatar George avatar  avatar  avatar  avatar

phala-wiki-next's Issues

Adjust code block background

Now the background of code blocks in light mode is in a yellow tune. We should ask the designer to figure out how to deal with it.

image

Add Landing Page

Summary

Add a Landing Page

Add blank landing page in the doks framework for the english language. Modifications will be done .

Header scrolls down with page contents

Description

When scrolling down the page, the header moves with the page contents.

Steps to reproduce

Open any page and scroll down.

Expected result

The header should be fixed, only the page contents are scrolled down.

Problem following the 'Quick Start' guide in a Vultr rented hardware

Description

Trying the 'Quick Start' from https://wiki.phala.network/en-us/general/mining/mine-phala/#quick-start in a rented hardware in Vultr.

Steps to reproduce

Deploy instance: https://wiki.phala.network/en-us/general/mining/paas-miner/

Setup BIOS: https://wiki.phala.network/en-us/maintain/khala-mining/1-0-hardware-requirements/#2-disable-secure-boot

Except for UEFI mode that gets you stucked in UEFI Shell in the startup. Selected Legacy mode instead: https://wiki.phala.network/en-us/maintain/khala-mining/1-0-hardware-requirements/#3-use-uefi-boot

Save and reboot: https://wiki.phala.network/en-us/maintain/khala-mining/1-0-hardware-requirements/#4-save--reboot

Install drivers for Intel SGX: https://wiki.phala.network/en-us/maintain/khala-mining/1-0-hardware-requirements/#supported-operating-systems

Installed Phala mining tools: https://wiki.phala.network/en-us/maintain/khala-mining/1-1-installing-phala-mining-tools/

Tryied the 'Quick Start': https://wiki.phala.network/en-us/general/mining/mine-phala/#quick-start

Expected result

I don't know.

Actual result

--2022-02-24 19:44:36-- https://raw.githubusercontent.com/Phala-Network/solo-mining-scripts/improvement-test/gui.sh
Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 185.199.111.133, 185.199.108.133, 185.199.109.133, ...
Connecting to raw.githubusercontent.com (raw.githubusercontent.com)|185.199.111.133|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 10991 (11K) [text/plain]
Saving to: ‘STDOUT’

  •                                       100%[========================================================================================>]  10.73K  --.-KB/s    in 0s      
    

2022-02-24 19:44:36 (58.2 MB/s) - written to stdout [10991/10991]

main: line 11: break: only meaningful in a for', while', or `until' loop
Hit:1 https://download.fortanix.com/linux/apt xenial InRelease
Hit:2 http://us.clouds.archive.ubuntu.com/ubuntu impish InRelease
Get:3 http://security.ubuntu.com/ubuntu impish-security InRelease [110 kB]
Get:4 http://us.clouds.archive.ubuntu.com/ubuntu impish-updates InRelease [110 kB]
Get:5 http://us.clouds.archive.ubuntu.com/ubuntu impish-backports InRelease [101 kB]
Fetched 321 kB in 1s (423 kB/s)
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
All packages are up to date.
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
Calculating upgrade... Done
0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
unzip is already the newest version (6.0-26ubuntu1).
wget is already the newest version (1.21-1ubuntu3).
0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.
Archive: improvement-test.zip
2c9bdca0f5ff9d56e6422518dd4078ae97862636
creating: solo-mining-scripts-improvement-test/
inflating: solo-mining-scripts-improvement-test/.env
inflating: solo-mining-scripts-improvement-test/.gitignore
inflating: solo-mining-scripts-improvement-test/LICENSE
inflating: solo-mining-scripts-improvement-test/README.cn.md
inflating: solo-mining-scripts-improvement-test/README.md
inflating: solo-mining-scripts-improvement-test/console.js
inflating: solo-mining-scripts-improvement-test/docker-compose.yml
inflating: solo-mining-scripts-improvement-test/gui.sh
inflating: solo-mining-scripts-improvement-test/install.sh
inflating: solo-mining-scripts-improvement-test/phala.service
creating: solo-mining-scripts-improvement-test/scripts/
creating: solo-mining-scripts-improvement-test/scripts/cn/
inflating: solo-mining-scripts-improvement-test/scripts/cn/config.sh
inflating: solo-mining-scripts-improvement-test/scripts/cn/console.js
inflating: solo-mining-scripts-improvement-test/scripts/cn/install_phala.sh
inflating: solo-mining-scripts-improvement-test/scripts/cn/logs.sh
inflating: solo-mining-scripts-improvement-test/scripts/cn/phala.sh
inflating: solo-mining-scripts-improvement-test/scripts/cn/start.sh
inflating: solo-mining-scripts-improvement-test/scripts/cn/status.sh
inflating: solo-mining-scripts-improvement-test/scripts/cn/stop.sh
inflating: solo-mining-scripts-improvement-test/scripts/cn/uninstall.sh
inflating: solo-mining-scripts-improvement-test/scripts/cn/update.sh
inflating: solo-mining-scripts-improvement-test/scripts/cn/utils.sh
creating: solo-mining-scripts-improvement-test/scripts/en/
inflating: solo-mining-scripts-improvement-test/scripts/en/config.sh
inflating: solo-mining-scripts-improvement-test/scripts/en/console.js
inflating: solo-mining-scripts-improvement-test/scripts/en/install_phala.sh
inflating: solo-mining-scripts-improvement-test/scripts/en/logs.sh
inflating: solo-mining-scripts-improvement-test/scripts/en/phala.sh
inflating: solo-mining-scripts-improvement-test/scripts/en/start.sh
inflating: solo-mining-scripts-improvement-test/scripts/en/status.sh
inflating: solo-mining-scripts-improvement-test/scripts/en/stop.sh
inflating: solo-mining-scripts-improvement-test/scripts/en/uninstall.sh
inflating: solo-mining-scripts-improvement-test/scripts/en/update.sh
inflating: solo-mining-scripts-improvement-test/scripts/en/utils.sh
inflating: solo-mining-scripts-improvement-test/sgx_enable
--------------Install phala scripts-------------
Uninstall old phala scripts
----------Your system is not supported. Phala currently only supports Ubuntu 18.04/Ubuntu 20.04----------
Install new phala scripts
Install phala command line tool
ln: failed to create symbolic link '/usr/bin/phala': File exists
------------Install success-------------
Intel SGX is already enabled on this system
----------Your system is not supported. Phala currently only supports Ubuntu 18.04/Ubuntu 20.04----------
----------Your system is not supported. Phala currently only supports Ubuntu 18.04/Ubuntu 20.04----------

Environment

Ubuntu 21.10

dead link / wrong redirects

Description

Link redirects to the wiki site are returning 404 on github and on the phala.network domain most of the sublinks returns to:

https://wiki.phala.network/en-us/general/phala-network/phala-network/

Steps to reproduce

Trying this page:

https://wiki.phala.network/en-us/docs/khala-mining/3-0-console/
https://wiki.phala.network/en-us/docs/khala-mining/4-0-faq/#confidence-level
https://wiki.phala.network/en-us/docs/phala-network/phala-network/
https://wiki.phala.network/en-us/docs/

Expected result

Should be landing into the specified hyperlinks.

Add wiki contribution guidelines

Summary

Contribution guidelines for the community should be in the README.md.
This may include style guidelines when editing existing content & adding content.

A full list of processes can be curated as the wiki grows...

Basic example

For instance

  • It is essential when mentioning SGX to understand that it is a trademarked product.
  • For formal correctness, it should always be accompanied with the term 'Intel' + '®' then 'SGX' added to result in 'Intel® SGX'

Motivation

This can make the review of PRs easier (save time) and add conciseness to the reader with overall quality improvements.

Feel free to suggest more ideas in comments below.

docs-navigation buttons in PR #49

Description

The docs-navigation in PR #49 is not showing the next articles as expected in chronological order.

Steps to reproduce

ceff2ac2-40e1-4b83-96aa-132de1eaa9a9

Expected result

The articles should be listed in the buttons in chronological order.

Wiki page - Mining console link broken

Description

Link broken as it is referring to the page of the old mining page.

image

Steps to reproduce

Step 1: Go on page ==> https://wiki.phala.network/en-us/mine/khala-mining/khala-mining-guide/
Step 2: Click on "Mining Console"
image

Expected result

The link should have been redirected to the stakepool page ==> https://app.phala.network/farm/stake-pool
image

Actual result

The link is redirected to the old mining console.
image

Environment

Ubuntu 5.19.0-35-generic
Intel(R) Core(TM) i5-6200U CPU @ 2.30GHz
Version 1.48.171 Chromium: 110.0.5481.177 (Build officiel) (64 bits)

404. New Wiki cannot be loaded. See netlify preview.

Description

Issue comes since new PR. After investigating any version before this commit: 1d7f9c2 seems to work.

Steps to reproduce

This only appears when the npm server is restarted.

Expected result

Pages should load.

Actual result

Also check current Netlify deployment, pages are not loaded.

404 error without any issues in the logs

image

image

Environment

> @hyas/[email protected] precheck
> npm version

{
  '@hyas/doks': '0.3.4',
  npm: '8.1.0',
  node: '16.13.0',
  v8: '9.4.146.19-node.13',
  uv: '1.42.0',
  zlib: '1.2.11',
  brotli: '1.0.9',
  ares: '1.17.2',
  modules: '93',
  nghttp2: '1.45.1',
  napi: '8',
  llhttp: '6.0.4',
  openssl: '1.1.1l+quic',
  cldr: '39.0',
  icu: '69.1',
  tz: '2021a',
  unicode: '13.0',
  ngtcp2: '0.1.0-DEV',
  nghttp3: '0.1.0-DEV'
}

> @hyas/[email protected] check
> exec-bin node_modules/.bin/hugo/hugo version

update requirements of cargo-contract in the "Environment Setup"

cargo-contract previous version (up to 1.5.1) required to install binaryen package to get wasm-opt
version 2.0.0 doesn't need it anymore
as stated in the "ink! 3.x to 4.0" migration guide (https://use.ink/faq/migrating-from-ink-3-to-4/)
also no more cargo +nightly contract is required
we should now be able to compile with cargo contract build

this page need to be updated to reflect these changes:
https://wiki.phala.network/en-us/build/stateless/setup/

Add expanding & collapsing sections

Summary

This feature would improve readability and allow the reader to focus on what they need to read most.

Basic example

The reader can expand and collapse the respective sections.

Motivation

The reader could pick their platform (OS) and avoid verbosity when reading. Only the required content would be seen.
Specifically relevant for:

  • /en-us/docs/khala-mining/1-1-hardware-requirements/
  • /en-us/docs/developer/run-a-local-development-network/

Terminal

Summary

Being able to add a terminal instead of a GIF.

Basic example

Similar as here: Website example
Source Code.

Motivation

This will simplify the aspects for the reader through a cleaner design.

Change the font.

TODO: Change the font globally in Doks to comply with Phala design and potentially reuse font of current wiki.
This is necessary prior to launching the new wiki.

Add sugguestions for ContractTrapped

Many reasons can cause ContractTrapped. One of them is that the contract panicked. We can build the contract without --release to see the panic message.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.