primihub / primihub-docs

PrimiHub document website

Primihub Docs

This is the source code for PrimiHub Docs.

We really apprecitate it if you would contribute to the content or the theme. You can do your contribution as follows.

Contribution

This site is built with Docusaurus 2.

Site content is written in Markdown format located in /docs. For simple edits, you can directly edit the file on GitHub and generate a Pull Request.

Prerequisite

This project requires Node.js to be v14.0.0 or higher. Install Node.js in your local machine if necessary.

Run & Edit Locally

Clone the repo, then edit and run it locally.

yarn # install dependencies 
yarn start # This command opens up a browser window and will apply your local changes without having to restart.

Routing

Each route you browse at https://docs.primihub.com/ comes with a markdown file in this project at /docs.

For example, the file for https://docs.primihub.com/docs/developer-docs/roadmap is /docs/developer-docs/roadmap.md.

Route with multiple pages

It will generate a default index page for a route which contains sub files. You need to create a _category_.json file in route folder. See /docs/developer-docs/core-concept for more details.

How to Insert an Image

1. Prepare your image files and place them in /static/img folder, e.g. /static/img/xxx.jpeg
2. Refer the image in markdown file with ![image desc](/img/xxxx.jpeg)

Meta data

Beside the content, please don't forget adding the following metadata at the header of a Markdown file:

keywords: [case1, case2]
description: This is a brief introduction to the content

The metadata will make the search engine index our content easily.

Menu

Please update sidebars.js if you want to add a new menu item.

Localization

Please put translation items into the following JSON file if you want to add a translation for English:

i18n/en/docusaurus-plugin-content-docs/current.json

You could start it with a particular language with the following command:

yarn start --locale en

primihub-docs's Issues

Request to support the search feature

See also https://docusaurus.io/community/resources#search

Doc typo:

https://github.com/primihub/primihub-docs/blob/main/docs/advance-usage/create-tasks/fedreated-learning/chatglm.md

"roles":
    {"client":["Alice", "Bob"],
    "server": ["Charlie"]},

typo:
roles：设置每一个参与方的角色行为，例如 Alice 和 Bob 是 server，Charlie 是 client

Request to have a document about how to run the unit test of PrimiHub

It's important to know how to run the unit tests. Please feel free to add the document here.

反馈问题

感谢您使用 PrimiHub！可以在这里写下阅读文档时发现的问题，让我们一起通过开源协作的方式让 PrimiHub 文档变得更好。

点击 Emoji 评价我们的文档质量。

Unable to run node

There is no error in the process of compiling the code, but an error is reported when running the node, as shown below:

Request to restructure the catalog of the document

Considering people might be interested in different content due to they have a different backgrounds. Let's assume they might be:

• End users
• Potential contributors
• Learners

We should provide a top menu for each role. Such as:

Role	Menu Item
End users	User Guide
Potential contributors	Developer Guide
Learner	Learning Guide

User Guide

There're some important things that are necessary for the user guide.

• Explain the main purpose or feature of each page
• Provide a common use case for each function
• Provide the link to some key concepts, such as PIR, PSI .eg.
• Explain the data structure, given samples. It would be better if users could download those sample files
• Explain the input and result of each important (or complex) function

Developer Guide

Developers need to know the following things before they get started to contribute:

• Structure of the directory
• How to compile the codes
• How to run the unit tests (and other kinds of tests)
• Code style
• The checklist before they try to create a pull request

Learning Guide

From a learner's perspective, the most valuable content is the learning material in this area. For example, we could provide some content for a different levels of learners.

• Beginner
  • Core concepts of this area. For example, MPC, PIR
• Medium
  • Theory explanation
• Advanced

References

• https://argo-cd.readthedocs.io/en/stable/

Suggestion: provide a docker image for the TEE environment

It would be much simple if we could have a docker image that could be a TEE environment. People could have a try easily.

See also https://docs.primihub.com/en/docs/advance-usage/create-tasks/tee-task

redirect website encountes error

https://docs.primihub.com/docs/advance-usage/python-sdk/install/

Request to add document about the derived data feature

Suggestion items:

• Explanation of what the derived data is
• Introduce how to use this feature

We could put it on here.

Got errors when run the instructions on the quick start page

See also the output:

root@node1:~# $ git clone https://github.com/primihub/primihub.git
bash: $: 未找到命令
root@node1:~# $ cd primihub
bash: $: 未找到命令