Skip to content

Commit

Permalink
Update: update contributor program and some contents about wiki platform
Browse files Browse the repository at this point in the history
  • Loading branch information
@MatthewJeffson
MatthewJeffson committed Sep 1, 2024
1 parent 5ce2968 commit 434ac95
Show file tree
Hide file tree
Showing 13 changed files with 362 additions and 385 deletions.
182 changes: 1 addition & 181 deletions HOW_TO.md
View file
Original file line number Diff line number Diff line change
@@ -1,181 +1 @@
### Thank you for considering to contribute to our seeed-studio files!

You can check these steps to set up your own files management platform:

1. Fork this repository into your GitHub.
2. Clone the repository you forked to your coding device.
3. Make your modifications, changing existed files or add new files. ---- for detailed local deployment / installation please check below instruction.
4. Commit your modifications and push to your Github repository.
5. Create a PR from the branch in your forked to seeed-studio's wiki-documents main branch.


###

export PATH=$PATH:/home/w0x7ce/Desktop/node-v18.12.1-linux-x64/bin

## Local Installation

[INSTALL LATEST LTS NODE](https://github.com/nodejs/release#release-schedule)

```bash
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
```

```bash
sudo apt remove cmdtest
sudo apt update && sudo apt install yarn
```

### Auto Install

```bash
yarn
```
This command will help you install all the dependences in package.json


```bash
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

```bash
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

```bash title='Signed'
Signed-off-by: tianrking <[email protected]>
```

## Custom Install & Plugin Install

### Mermaid

```bash
yarn add @docusaurus/theme-mermaid
```

### MDX

```bash
yarn add remark-math@3 rehype-katex@4
```

### jq

```bash
curl -O https://get.0install.net/0install.sh && chmod +x 0install.sh
sudo ./0install.sh install local
0install add jq https://apps.0install.net/utils/jq.xml
```

### algolia

```bash
yarn add @docusaurus/theme-search-algolia
```

### Math

```bash
yarn add remark-math@3 rehype-katex@5 [email protected]
```

### plugin-content-docs

```bash
yarn add @docusaurus/plugin-content-docs
```

### plugin-pwa

```bash
yarn add @docusaurus/plugin-debug
yarn add @docusaurus/plugin-pwa
```

### Git

#### Cache

```bash
git config --global http.postBuffer 524288000
```

#### Speed

```bash
git config --global http.lowSpeedLimit 0
git config --global http.lowSpeedTime 999999
```

#### depth

```bash
git clone --depth=1 http://xxx.git
git fetch --unshallow
```

#### gitignore

```bash
git rm -r --cached .
git add .
git commit -m 'update .gitignore'
```


## Develop

### Offical Function

Using SSH:

```bash
USE_SSH=true yarn deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

### Custom Deployment (We Used)

#### SSH KEY

[GENERATE SSH KEY](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)

[Add SSH KEY](https://github.com/settings/keys)

[Github Actions](https://github.com/{$USER}/{Workspace}/settings/secrets/actions)

### Problems

1. [ERROR] Error: ENOSPC: System limit for number of file watchers reached

- insert the new value into the system config

```bash
echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

```

- check that the new value was applied

```bash
cat /proc/sys/fs/inotify/max_user_watches
```

- config variable name (not runnable)

```bash
fs.inotify.max_user_watches=524288
```
We offer two different PR ways on the wiki platform. Please check the [Contributor Guide](https://wiki.seeedstudio.com/Contributor/).
97 changes: 94 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,99 @@ Seeed Studio has dedicated to realizing interactive digital replica of our physi

This is the Github source files for Seeed Studio.

You can constantly receive updated data from sensors and sensors network, access computational resources with different edge computing power, display and manage information on cloud and chain in ways.
## What does this Wiki Platform Cover?

We here present you our [current accomplishments](/Getting_Started) and solutions and we are looking for your [contributions](https://github.com/Seeed-Studio/wiki-documents/discussions/339).
This platform will focus on four main topics as shown in the sidebar, with up-to-date information on all of our products.

You can [set up](https://wiki.seeedstudio.com/Deploy_Page_Locally) this platform locally.
- [Sensors and Sensing](https://wiki.seeedstudio.com/Sensor_Network/)
- [Networking](https://wiki.seeedstudio.com/Network/)
- [Edge Computing](https://wiki.seeedstudio.com/Edge_Computing/)
- [Cloud Services](https://wiki.seeedstudio.com/Cloud/)
- [Browser-based AI Solution](https://sensecraft.seeed.cc/ai/#/model)
- [Technology Topics](https://wiki.seeedstudio.com/topicintroduction/)
- [Contributor Program](https://wiki.seeedstudio.com/Contributor/)
- [Weekly Wiki](https://wiki.seeedstudio.com/weekly_wiki/)

[![button](https://files.seeedstudio.com/wiki/New_Wiki_Platform/example/showcase2.png)](https://wiki.seeedstudio.com/Getting_Started/)

## Quick Links

Thanks for our [contributors](https://wiki.seeedstudio.com/contributors/), the collection pages are done and here are the quick links:

### Sensor and Sensing

- [Grove Ecosystem](https://wiki.seeedstudio.com/Grove_System/)
- [SenseCAP Ecosystem](https://wiki.seeedstudio.com/SenseCAP_introduction/)
- [XIAO Series](https://wiki.seeedstudio.com/SeeedStudio_XIAO_Series_Introduction/)
- [Wio Terminal](https://wiki.seeedstudio.com/Wio_Terminal_Intro/)

[![button](https://files.seeedstudio.com/wiki/xiao_topicpage/main.jpg)](https://wiki.seeedstudio.com/SeeedStudio_XIAO_Series_Introduction/)

### Networking

- [Meshtastic Network](https://wiki.seeedstudio.com/meshtastic_introduction/)
- [SenseCAP Gateway](https://wiki.seeedstudio.com/Network/SenseCAP_Network/SenseCAP_Gateway_Intro/)
- [Raspberry Pi Network Solution - reRouter](https://wiki.seeedstudio.com/reRouter_Intro/)
- [Rockchip Netowrking Solutions](https://wiki.seeedstudio.com/Rockchip_network_solutions/)

[![button](https://meshtastic.org/assets/images/lora-topology-2-c80684f1eafdf2a71fbaf26e494fb26d.webp)](https://wiki.seeedstudio.com/meshtastic_introduction/)

### Edge Computing

- [Raspberry Pi-related Devices](https://wiki.seeedstudio.com/raspberry-pi-devices/)
- [NVIDIA Jetson®-related Devices](https://wiki.seeedstudio.com/NVIDIA_Jetson/)
- [ESP-powered Controller](https://wiki.seeedstudio.com/Edgebox-ESP-100-Arduino/)
- [BeagleBone®](https://wiki.seeedstudio.com/BeagleBone/)
- [ODYSSEY](https://wiki.seeedstudio.com/ODYSSEY_Intro/)

[![button](https://files.seeedstudio.com/wiki/wiki-platform/collection_page/NVIDIA_Jetson_collection_front.jpg)](https://wiki.seeedstudio.com/NVIDIA_Jetson/)

### Cloud

- [SenseCAP Dashboard](https://wiki.seeedstudio.com/Cloud_Chain/SenseCAP_Dashboard/Dashboard_Basics/)
- [SenseCAP API](https://wiki.seeedstudio.com/Cloud_Chain/SenseCAP_API/SenseCAP_API_Introduction/)
- [SenseCraft AI](https://wiki.seeedstudio.com/sensecraft_ai/)

[![button](https://sensecraft.seeed.cc/wp-content/uploads/2023/11/%E5%88%87%E5%9B%[email protected])](https://wiki.seeedstudio.com/sensecraft_ai/)

### Technology Topics and Popular Platforms

- [Home Assistant](https://wiki.seeedstudio.com/home_assistant_topic/)
- [TinyML](https://wiki.seeedstudio.com/tinyml_topic/)
- [Open Source](https://wiki.seeedstudio.com/open_source_topic/)
- [Edge AI](https://wiki.seeedstudio.com/edge_ai_topic/)
- [Arduino](https://wiki.seeedstudio.com/Arduino/)
- [Raspberry Pi](https://wiki.seeedstudio.com/Raspberry_Pi/)
- [Micro:bit](https://wiki.seeedstudio.com/microbit_wiki_page/)

[![button](https://files.seeedstudio.com/wiki/HomeAsssitant_collection/HAbanner1.jpg)](https://wiki.seeedstudio.com/home_assistant_topic/)

## Contributions

In Seeed, we greatly value our community of Seeeders. The [Seeed Studio Contributor Program](https://wiki.seeedstudio.com/Contributor/) is a collaborative program launched to unite our dear friends from all over the world and co-build innovative solutions together.

- [Pull Request Guide](https://wiki.seeedstudio.com/Contribution-Guide/)
- [Full steps to PR](https://wiki.seeedstudio.com/full_steps_pull_request/) - Able to [see the changes locally](https://wiki.seeedstudio.com/Deploy_Page_Locally)
- [Quick steps to PR](https://wiki.seeedstudio.com/quick_pull_request/) - Direct upload with md files and images.

[![button](http://files.seeedstudio.com/wiki/wiki-platform/contributor/contributors.png)](https://wiki.seeedstudio.com/Contributor/)

### More about Collaborative Programs

- [The Ranger Program](https://wiki.seeedstudio.com/ranger/)
- [The Contributor Program](https://wiki.seeedstudio.com/contributors/)
- [Apply for Rangers](https://docs.google.com/forms/d/e/1FAIpQLSdiAWHmRJqgVNTJyJDkzhufc1dygFyhWFyEtUTm-mrgSKaEgg/viewform)
- [Direct to Assignment](https://github.com/orgs/Seeed-Studio/projects/6)
- [More information to Rangers](https://www.seeedstudio.com/blog/2023/09/15/join-the-seeed-ranger-program-empowering-developers-and-building-communities/)
- [More information to Contributors](https://wiki.seeedstudio.com/Contributor/)

[![button](http://files.seeedstudio.com/wiki/wiki-platform/contributor/github_assignment_2.png)](https://github.com/orgs/Seeed-Studio/projects/6)

## Tech Support & Product Discussion

Thank you for choosing our products! We provide many forms of support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs.

- [Forum](https://forum.seeedstudio.com/) - Ideas Exchange
- [Email](https://www.seeedstudio.com/contacts) - Expert Supports
- [Discord](https://discord.com/invite/eWkprNDMU7) - Collective Chatting
- [GitHub Discussion](https://github.com/Seeed-Studio/wiki-documents/discussions/69) - Wiki Suggestions
Empty file added docs/Contribution/Contributor_Files/md_file_and_images_storted_here.txt
View file
Empty file.
82 changes: 14 additions & 68 deletions docs/Contribution/Contributors/Contribution-Guide/Contribution-Guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,86 +12,32 @@ last_update:

# Contribution(Pull Request) Guide



<strong><font color={'8DC215'} size={"5"}>Thanks for your efforts! <br /> Please follow steps below to complete your submission on GitHub.</font></strong>

## Before everything starts

- Please make sure you can [build the wiki platform page locally](/Deploy_Page_Locally)
- All files to be uploaded(pull request) should be placed in this path:
`/docs/Contribution/Contributors/file_transfer_station/"create a folder to store your files"`

## Step by Step submit the files to repository

Here are the detailed uploading steps.

### 1. Bring your forked branch up to date

<div align="center"><img width={700} src="https://files.seeedstudio.com/wiki/wiki-platform/contributor/PR_Guide/1.jpg" /></div>

### 2. Update the downloaded files

Use the code below and update the downloaded files.

```
git checkout docusaurus-version
git pull
```

### 3. Modify the contents of existed files

All the files on the wiki platform are stored in the "docs" folder.
## Option 1: Full steps to PR

<div align="center"><img width={500} src="https://files.seeedstudio.com/wiki/wiki-platform/contributor/PR_Guide/2.jpg" /></div>
1. For the first, please make sure you can [build the wiki platform page locally](/Deploy_Page_Locally)
2. Now You can do the changes or add the files, while seeing the changes locally. Then PR to our repo.

:::note
The name of file you want to change usually is the last part of the url(take Seeed Studio XIAO ESP32C3 as an example).
<div align="center"><img width={700} src="https://files.seeedstudio.com/wiki/wiki-platform/contributor/PR_Guide/3.jpg" /></div>
:::
- [Full steps to PR](/full_steps_pull_request)

### 4. Check the files changed locally
## Option 2: Quick steps to PR

Once you done updating, you can use the command below to see whether it shows fine.
You can just download all required files and add md file as well as images, then direct PR to our repo.

```
yarn start
```
- [Quick steps to PR](/quick_pull_request)

On the edit platform:
## Useful Links:

![image4](https://files.seeedstudio.com/wiki/wiki-platform/contributor/PR_Guide/4.jpg)

On the local page:

![image5](https://files.seeedstudio.com/wiki/wiki-platform/contributor/PR_Guide/5.jpg)

### 5. Save and push the changes to your forked github repository

If all is ok, you can use the command below to push the changes to your forked github repository.

```
git add "the files that you changed"
git commit -m "Update：I have updated ..."
git push
```

### 5. Pull request to the Seeed Studio Repository

Once you have pushed the changes to your github repository, there is a column showing up automatically. Click the "Compare & Pull Request" button:

![image6](https://files.seeedstudio.com/wiki/wiki-platform/contributor/PR_Guide/6.jpg)

Show us what you have edited and click "creat pull request" button to us.

![image7](https://files.seeedstudio.com/wiki/wiki-platform/contributor/PR_Guide/7.jpg)

Thank you for your contributions!
- [The Contributor Program Introduction](/Contributor)
- [The Contributors Presented Page](/contributors)
- [Assignments on GitHub](https://github.com/orgs/Seeed-Studio/projects/6)

## FAQ

### 1. Where do I keep the images?

You can simply place them in the same path as the .md file you changed, and then name them with number in the order they are used in the file.
Store all files(The markdown files and pictures) in the "Contributor_Files" folder:

<p style={{textAlign: 'center'}}><img src="http://files.seeedstudio.com/wiki/wiki-platform/contributor/files_stored.png" alt="pir" width={800} height="auto" /></p>

Hint: Check the folder in ``"wiki-documents/docs/Contribution/Contributors/Deploy_Page_Locally/Deploy_Page_Locally.md"``
Loading

0 comments on commit 434ac95

Please sign in to comment.