Skip to content

Latest commit

 

History

History
88 lines (40 loc) · 5.55 KB

Content Update Guide.md

File metadata and controls

88 lines (40 loc) · 5.55 KB
Raw

Introduction

EIPs Fun is a project driven by the community, and we invite all creators to join in content creation and sharing. Our content updates are carried out through GitHub.

For the website, community can contribute to the “Videos”, “Adopted by projects”, and “Further reading” sections of each EIP.

Workflow

Suppose you are reading the EIP-xxxx webpage and notice that the some sections need updates. And luckily, you have come across an awesome project or media that implements EIP-xxxx before, and you are excited to add it to the webpage and share it with the community. Let’s begin!

  1. You need to have a GitHub account to make content updates.

  2. To access the GitHub repository for the EIPs Fun project, simply click on the link provided below. Once you are there, click on the "fork" tab located in the top right corner to create your very own repository of EIPs Fun. If you're interested in learning more about the "fork" feature, feel free to click here.

    https://github.com/lxdao-official/eipsfun

  3. You can find EIP-xxxx.md in your repository at eipsfun/content/en/EIP-xxxx.md.

Each document contains guidelines for the respective section. You can follow those to update the content accordingly. If you are not very familiar with GitHub and are still unsure of what to do, please continue.

  1. It’s the document for content updates. You can see the headings "Videos", "Projects", and "Further reading" here. The content under these headings are for us to update the content, corresponding to the "Videos", "Adopted by projects", and "Quick read" sections on the webpage respectively.

    image

  2. Then click on the code tab. With the Markdown code examples provided under these headings, you can substitute them using the content you want to update.

    image

  3. Great work! Now that you've added your changes, all you need to do is preserve them and submit them through the commit and Pull Request. If you're interested in learning more about the "commit" and “pull request” feature, feel free to click here, and here. After that, your pull request should be public in the lxdao-official/eipsfun repository. Thanks for your contribution!

    image

  4. Our developers and editors will review your pull request as soon as possible and provide feedback.

Remarks

Well, the previously mentioned steps are the exact procedure for updating website content. We are excited to receive your contributions, and we appreciate your support for EIPs Fun!

介绍

EIPs Fun 致力于成为一个社区驱动的项目，因此欢迎一切建设者参与内容创作与传播。我们的网站内容更新通过 GitHub 完成。

目前，在每个 EIP 中，社群成员可以添加 “Adopted by projects”, “Videos”, 与 “Further reading” 模块的内容；受到页面排版限制，前两个模块的内容上限为 4 个，”Videos” 模块中可添加的内容为 3 个视频链接。

操作流程

首先，请想象你正在阅读 EIP-xxxx 的页面，发现这三个模块中的内容等待添加。而你正好看到过一个应用 EIP-xxxx 的好项目或者解读它的好内容，想把它补充进来，分享给所有人。

  1. 你需要有一个 GitHub 账号，以进行内容更新。

  2. 点击链接，进入 EIPs Fun 项目的 GitHub 仓库。 点击右上方的 “fork” tab，创建你自己的版本库。如果你想详细了解 “fork” 功能，请点击此处。

    https://github.com/lxdao-official/eipsfun

  3. 在自己的版本库中，跟随路径，进入 EIP-xxxx.md：eipsfun/content/en/EIP-xxxx.md

每个文档内都有相应模块的样式，你可以根据它们去更新内容。如果你不太熟悉 GitHub，仍不知该怎么做，请继续往下看。

  1. 这是内容更新的文档，你可以在其中看到 “Videos”, “Projects”, 和 “Further reading” 三个标题，标题下的内容是我们进行内容更新的工具，它们分别对应网页上的 “Videos”, “Adopted by projects”，和 “Quick read” 模块。

    image

  2. 请点击 “code” tab，根据页面里的代码样例，将内容的相应标题与链接等复制过来。

    image

  3. 添加完毕后，请通过 commit 与 pull request 功能保留并提交你的更改，成功后，你会在 lxdao-official/eipsfun repository 中看到你的 pull reuqest。

    image

  4. 开发人员会尽快审核你的 pull request 并给予反馈。

结语

好了，以上就是更新网站内容的具体流程。

期待你分享和更新的内容，感谢你对 EIPs Fun 的贡献！