Git Product home page Git Product logo

wuhan2020.github.io's Introduction

Wuhan2020 Community Official Website

CI wuhan2020.github.io deploy

All website material of https://community.wuhan2020.org.cn

Prerequisite

wuhan2020.github.io is powered by docsite. Please read https://docsite.js.org Please make sure your version of docsite is docsite@wuhan2020. Please also make sure your node version is higher than 8.x.

Build instruction

  1. Run npm i docsite@wuhan2020 -g to install docsite for project wuhan2020.
  2. Run npm i in the root directory to install the dependencies.
  3. Run npm run start in the root directory to start a local server, you will see the website in 'http://127.0.0.1:8080'.
  4. Run npm run build to build source code.
  5. Verify your change locally: python -m SimpleHTTPServer 8000, when your python version is 3 use :python3 -m http.server 8000 instead.

If you have higher version of node installed, you may consider nvm to allow different versions of node coexisting on your machine.

  1. Follow the instructions to install nvm.
  2. Run nvm install 10 to install node 10.x.
  3. Run nvm use 10 to switch the working environment to node 10.x.
  4. Run npm i docsite@wuhan2020 -g to install docsite for project wuhan2020.

Make sure npm and docsite are configured in the environmet configuration of os . eg: /etc/profile or .bash_profile of Macos.

Then you are all set to run and build the website. Follow the build instruction above for the details.

How To Write Documents

Add a new doc

  1. Add new .md file under docs/en-us or docs/zh-cn. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent.
  2. Update site_config/docs.js, add a new entry to the blog in either en-us or zh-cn.
  3. Run docsite start locally to verify the blog can be displayed correctly.
  4. Send the pull request containing the .md and doc.js only.

Add a new article for developers

  1. Add new .md file under docs/en-us/developers or docs/zh-cn/developers, the file name should end up with _dev.md. Note that the suffix _dev is necessary.
  2. Update site_config/develop.js, add a new entry in either en-us or zh-cn.
  3. Run docsite start locally to verify the article can be displayed correctly.
  4. Send the pull request containing the *_dev.md and develop.js only.

Add a new project showcase

  1. Open project.js directly and find the appropriate language block, such as "en-us".
  2. Add a project entry under projects.list and please make sure that the entry contains img, title, description and link.
  3. Run docsite start locally to verify the project can be displayed correctly.
  4. Send the pull request containing the project.js only.

Add a new blog

  1. Add new .md file under blog/en-us or blog/zh-cn. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent.
  2. Run docsite start locally to verify the blog can be displayed correctly.
  3. Send the pull request containing the .md only.
  4. SEO config is required.

notice : Blog documents will be automatically sorted by time, without menu configuration. Set 'hidden' to 'true' for documents you don't want to display temporarily`.

SEO

the type is :

---
hidden: false
title: title
keywords: keywords1,keywords2
description: some description
author: author name
date: 2018-12-29
---

How to Add a New Language

If you want to add a new language, such as Thai.

  1. Please append the element: { value: 'th-th', text: 'ภาษาไทย' } to the langList variable of site_config/site.js.
  2. Next, make a copy of en-us.js in i18n, and name it th-th.js. Now you can start translating phrases on the page.
  3. Then please add directories named th-th in docsand blog directories. Here you can copy articles from en-us, translate them, and then add them to th-th.

How to Add Sitemap for SEO

sitemap.xml is generated automatically by sitemap-generator.js during the deployment process.

Others

wuhan2020.github.io's People

Contributors

alexlinsy avatar annacici avatar anndawn avatar anpuli avatar atena1118 avatar bengbeng233 avatar chenrui333 avatar cnyoki avatar damingerdai avatar darlk avatar dependabot[bot] avatar frank-zsy avatar gakki88 avatar gindachen avatar iltc avatar imgbot[bot] avatar jeremy0519 avatar kevenleone avatar lovepoem avatar mathwyz avatar peaceiris avatar purple-force avatar rrfhouden avatar sciulli avatar shawnpanda avatar sunshinemingo avatar techquery avatar tinylittlemaggie avatar zhaofeng-shu33 avatar zhmushan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

wuhan2020.github.io's Issues

添加总体组织架构图和基本流程

页面设计:
image

文本内容 :

感谢您的支持,请按以下步骤完成初步志愿者分流

流程 备注

1、修订 群名片

格式【意向组+昵称/姓名】

如您不知道自己适合哪个组别,请翻下

一页

2、填写问卷

https://shimo.im/forms/PWTTvkrdcCyXCGX6/fill

请尽量完成问卷信息,如您需要保密个

人隐私,可不填写真实姓名

3、扫码加入志愿加入的对应组别,并退出本群

(除了协调组的志愿者)

请根据您所填写的志愿组,扫描对应组

别的二维码加入,协调组请联系陈奕竹

审核(建议不要同时加入超过2个志愿

组,防止工作量过大

其他两部分请用项目中的图片 :

/images/team-arch.jpg 和 /images/team-qr-code.png

意大利语首页文字重叠

当前问题

意大利语首页文字重叠,页面越窄重叠越厉害,最后还会出现文字超出边界的问题。

image

image

image

image

对比中文页面:

image

[doc] README for Translator

Let's pin an issue page referring to the following tutorials to the translator-guide at root:

  • Translator 3 min quick start
  • How to add a new language?
  • How to post a task?
  • How to ask for a task, accept a task, and finish a task?

Logistics:

  • Also link these questions in FAQ

Add a section to give thanks to all of the Sponsors

1、Slackbot 8:16 AM
Your workspace is getting a free trial of Slack's Standard Plan through February 29th!:tada: On the Standard plan, your team can now see all your past messages and files, add guests to your workspace, make group calls, and more.

2、Shimo
Free enterprise edition for wuhan2020 team

3、……

So, we need to add a section to give thanks to all of the Sponsors, e.g. shimo, slack, …

WSL下编译失败, 抛出YAMLException

环境:

  • nodejs: v12.15.0
  • os: ubuntu(WSL)

错误信息:

┌─[zhmushan@zhmushan-surface-go] - [/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io] - [2020-02-06 03:32:32]
└─[0] npm run build

> [email protected] build /mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io
> docsite build

YAMLException: bad indentation of a mapping entry at line 14, column 2:
     community:
     ^
    at generateError (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/js-yaml/lib/js-yaml/loader.js:167:          10)
    at throwError (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/js-yaml/lib/js-yaml/loader.js:173:9)               at readBlockMapping (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/js-yaml/lib/js-yaml/loader.js:1          107:7)
    at composeNode (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/js-yaml/lib/js-yaml/loader.js:1359:1          2)
    at readDocument (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/js-yaml/lib/js-yaml/loader.js:1519:          3)
    at loadDocuments (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/js-yaml/lib/js-yaml/loader.js:1575          :5)
    at load (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/js-yaml/lib/js-yaml/loader.js:1596:19)                   at Object.safeLoad (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/js-yaml/lib/js-yaml/loader.js:16          18:10)
    at Object.<anonymous> (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/docsite/lib/generateHTMLFile.          js:34:26)
    at Module._compile (internal/modules/cjs/loader.js:955:30) {
  name: 'YAMLException',
  reason: 'bad indentation of a mapping entry',
  mark: Mark {
    name: null,
    buffer: 'pages:\n' +
      '  # key is the dirname of pages in src/pages\n' +
      '  home:\n' +
      '    # 首页配置\n' +
      '    zh-cn:\n' +
      "      title: 'Wuhan2020'\n" +
      "      keywords: '官网,首页'\n" +
      "      description: 'Wuhan2020官网'\n" +
      '    # home config\n' +
      '    en-us:\n' +
      "      title: 'Wuhan2020'\n" +
      "      keywords: 'Official,Wuhan2020'\n" +
      "      description: 'Wuhan2020 Official Website'\n" +
      ' community:\n' +
      '    # 社区页配置\n' +
      '    zh-cn:\n' +
      "      title: '社区'\n" +
      "      keywords: 'Wuhan2020,社区'\n" +
      "      description: 'Wuhan2020社区'\n" +
      '    # community page config\n' +
      '    en-us:\n' +
      "      title: 'Community'\n" +
      "      keywords: 'Seata,Community'\n" +
      "      description: 'Seata Community'\n" +
      '  blog:\n' +
      '    # 博客列表页配置\n' +
      '    zh-cn:\n' +
      "      title: '博客'\n" +
      "      keywords: 'Wuhan2020,博客'\n" +
      "      description: 'Wuhan2020 博客'\n" +
      '    # blog list page config\n' +
      '    en-us:\n' +
      "      title: 'Blog'\n" +
      "      keywords: 'Wuhan2020,Blog'\n" +
      "      description: 'Wuhan2020 Blog'\n" +
      '\u0000',
    position: 304,
    line: 13,
    column: 1
  },
  message: 'bad indentation of a mapping entry at line 14, column 2:\n' +
    '     community:\n' +
    '     ^'
}
fs.js:27
const { Math, Object } = primordials;
                         ^

ReferenceError: primordials is not defined
    at fs.js:27:26
    at req_ (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/natives/index.js:143:24)
    at Object.req [as require] (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/natives/index.js:55:10)
    at Object.<anonymous> (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/vinyl-fs/node_modules/graceful-fs/fs.js:1:37)
    at Module._compile (internal/modules/cjs/loader.js:955:30)
    at Module._compile (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/pirates/lib/index.js:99:24)
    at Module._extensions..js (internal/modules/cjs/loader.js:991:10)
    at Object.newLoader [as .js] (/mnt/c/Users/zhmushan/Desktop/wuhan2020.github.io/node_modules/pirates/lib/index.js:104:7)         at Module.load (internal/modules/cjs/loader.js:811:32)
    at Function.Module._load (internal/modules/cjs/loader.js:723:14)

[媒体文章搬到社区网站] 文案10:如何加入到 wuhan2020 开源项目,打赢这场没有硝烟的战争?

中文标题:如何加入到 wuhan2020 开源项目,打赢这场没有硝烟的战争?
中文链接:https://mp.weixin.qq.com/s/YAMMgJH_EU7qzwHxppJXrw
英文标题:How to join wuhan2020 open source project, and survive this war without gunfire
英文链接:https://shimo.im/docs/5b4bb8b4dc064938/

标题作者请写媒体和作者名字
请使用 Typorahtml页面转化为markdown,放到社区频道.图片尽量下载到本站

[Disucssion] Page content enhancement

[Drafting...]

  1. 应该在主页/显眼的地方加一个link到官方通稿。当前是一定要点到博客才能看到官方通稿

    1. 解决1: 在主页和什么是WHU2020更改一下能access到这个blog
    2. 解决2: 另外开一个tab做官方通稿
    3. 解决3: 直接放到主页的下方
  2. Polish公告措辞:

    1. 项目入口:门户入口,GitHub入口,App入口--到底是哪个入口?
    2. (中文)公告的措辞可能可以让翻译组的朋友们也polish一下
  3. 加一个About Us在首页

@Atena1118 @lovepoem @chenrui333 Any suggestions / insight will be appreciated.

[媒体文章搬到社区网站] 文案xx -武汉莫慌

团队加班加点制作超暖心“武汉莫慌”漫画,献给所有为疫情加油的你!

在过去的两周,肆虐的疫情和不断增加的疑似确诊病例下,我们看到的是各种求助和悲伤的信息,看到了很多抗击在肺炎第一线的故事,还有更多的,是普通和平凡的我们,焦虑,担心,害怕,恐慌,和愤怒。

当你感觉到无法从这样的情绪网中挣扎出来时,可以尝试点击一下这个链接,武汉莫慌,我们都在:

https://q.eqxiu.com/s/5aYnTQLR?eqrcode=1&share_level=7&from_user=2020020653677c58&from_id=a0873018-c&share_time=1580966341969&from=groupmessage&isappinstalled=0

在一些页面添加邮件列表介绍

[doc] Add French Translation

This is the epic issues for adding French Translation. If you're a contributor, it would be great if you can open an issue for each of the sub tasks mentioned here.

To be translated (in priority)

Finished

  • docs/fr-fr/dev/mailing-list-guide.md: Wei XIE
  • docs/fr-fr/dev/information-guide.md: Contributing @bengbeng233
  • docs/fr-fr/overview:
  • docs/fr-fr/dev/dev-env-setup.md: Contributed by @AnnaCICI
  • blog/fr-fr/wuhan2020-official-announcement.md: @沈屹妍Camille from shimo
  • docs/fr-fr/dev/quickstart.md: Contributed by @AnnaCICI
  • docs/fr-fr/overview/what-is-wuhan2020.md: Contributed by @bengbeng233
  • docs/fr-fr/dev/contributing.md Contributed by @AnnaCICI
  • docs/fr-fr/overview/faq.md: Contributed by @bengbeng233
  • docs/fr-fr/developers/developers_dev.md: Contributed by @AnnaCICI
  • docs/fr-fr/user/website-guides.md: Contributed by @bengbeng233
  • blog/fr-fr/download.md: Contributed by @AnnaCICI

[Question] 如何新增一个语言

描述你需要修改或新增的文档

我记得我们曾经有一个README描述如何支持一个新的语言。

这个README现在还健在吗?希望能post出来作为文档给新人使用

如果有的话,请附图

额外的信息

[doc] Add Italian Translation

This is the epic issues for adding Italian Translation. If you're a contributor, it would be great if you can open an issue for each of the sub tasks mentioned here.

@sciulli It would be awesome if you can help coordinate the translation of these documentations to Italian:

列出项目列表

建议将本项目的项目管理报表定期定期发布在此repo
1、有一个统一的项目管理看板入口
2、便于团队成员了解项目全貌

[doc] Creation of Brazilian translation

Hello,

I've seen on the news many Brazilians living on Wuhan, and I know many others in whole China.
Could I add a translation in Portuguese - Brazil ?

I think this can benefit all the population that speak Portuguese.

The Get Started link is incorrect (EN, JP, IT)

The Get Started link should not go to

https://wuhan2020.github.io/en-us/docs/user/quickstart.html

but should go to

https://wuhan2020.github.io/en-us/docs/overview/what-is-wuhan2020.html

The Chinese version is correct, but English, Japanese and Italian link is incorrect.

@lovepoem

Japanese Page Link is Broken.

Many Japanese pages linked Mandarin pages.
I'd like to fix that, but I don't know that which file I should fix.
Which file is it?

How to add another langauge?

  1. Check site_config and see if there exist the entry of the langauge you add. If not, raise an issue about adding a language (like #120 )

  2. Add the entries for all the js like this commit in #121. You will see there are 5 files you need to edit, and basically it's copy and pasting materials and rename them by the country code.

Here is a rough checklist:

  • Determine you language code: fr-fr means French
  • In site_config/site.js: add the { value: 'fr-fr', text: 'French' }, to langLis3. t
  • In site_config/site.js: add the language specific dictionary entry like this
  • In site_config/home.js: add an entry like this
  • similarly in doc.js
  • similarly in develop.js
  • similarly in community.jsx
  • similarly in blog.js
  1. Create two direcotry under /blog and /doc with the language you specify. If you're adding fr-fr (French), then
  • Copy /doc/en-us to /doc/fr-fr
  • Copy /blog/en-us to /blog/fr-fr
  1. Raise a PR when you're done with the steps above. When the PR is passed, you can change / upload the documents in the language subdirectory and start translate the documentations.

Thanks for your contribution! If you want to add a translation to this documetation, comment below!

Add basic content to the website

Goal: our use does not lost in this maze of information. I will just add some (existing) content to the overview of the website.

  • Official Announcement
    • Chinese
    • English
    • Japnaese
    • Italian
  • Guide for general public
    • Chinese
    • English
    • Japnaese
    • Italian

If there are other basic contents that are needed in this moment, add to below.

[doc] Revise Japanese Translation

This is the epic issues for adding Italian Translation. If you're a contributor, it would be great if you can open an issue for each of the sub tasks mentioned here.

@RRFHOUDEN It would be awesome if you can help coordinate the translation of these documentations to Japanese. Feel free to distribute the tasks to other people in Slack with Japanese specialty, but call out the work below in comment so that we don't have duplicate works.

Ready for review:

Not translated yet:

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.