Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev update url scheme and update README #10

Merged
merged 3 commits into from
Dec 8, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ group :jekyll_plugins do
gem 'jekyll-feed', '0.9.3'
gem 'jekyll-seo-tag', '2.4.0'
gem 'jekyll-sitemap', '1.2.0'
gem 'jekyll-redirect-from', '0.14.0'
end
5 changes: 4 additions & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ GEM
nokogiri (= 1.8.2)
jekyll-feed (0.9.3)
jekyll (~> 3.3)
jekyll-redirect-from (0.14.0)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-seo-tag (2.4.0)
Expand Down Expand Up @@ -75,8 +77,9 @@ DEPENDENCIES
jekyll-archives (= 2.1.1)
jekyll-extract-element (= 0.0.7)
jekyll-feed (= 0.9.3)
jekyll-redirect-from (= 0.14.0)
jekyll-seo-tag (= 2.4.0)
jekyll-sitemap (= 1.2.0)

BUNDLED WITH
1.16.0
1.16.2
42 changes: 27 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@
**FydeOS FAQ & Knowledge base** - as the name suggests, it's the repository for FAQ and recipes for FydeOS and its related ecosystem. It's powered by [Jekyll](https://jekyllrb.com/), the static website engine behind Github pages. We decided to host it on Github pages so that you can contribute to perfect this repository and help others to better utilise FydeOS.


## Changelog
#### 2018-12-08
Updated URL schemes for the Knowledge base section:
- We are now using SEO friendly (and much shorter) human-readable plain English words as opposed to the longer article title which gets converted to [Punycode](https://en.wikipedia.org/wiki/Punycode).
- A redirect mechanism is in place for backward compatibility, previous URLs to all exisiting kb articles should still work, but on your browser it should be shwon as the updated shorter/friendlier URL.
- You will need to specify the SEO URL yourself when creating new Knowledge base articles by specifying `permalink:` in the front matter section, see below or exisiting kb articles for reference.
- It's also good to include a redirect to have previous `/:categories/:title` URL scheme (that may include Chinese character) also working, by specifying one or more `redirect_from:` in the front matter section, see below or exisiting kb articles for reference.


## How can I contribute

### Setup
Expand Down Expand Up @@ -32,11 +41,11 @@ Now you should have **FydeOS FAQ & Knowledge base** showing up on your browser a
- To create a new question, simply create a new `*.md` file within this directory, with the **name of your question** being the filename. e.g. `如何使用OTA升级我的FydeOS?.md`.
- Edit this Markdown file you've just created, with content being the answer to the question. Note that the **first two lines of triple dashes** need to be preserved on each file, e.g.

```
---
---
Your answer here
```
```
---
---
Your answer here
```
- Save your file, you should be able to find your item on the FAQ page.

2. Knowledge base item
Expand All @@ -45,16 +54,19 @@ Now you should have **FydeOS FAQ & Knowledge base** showing up on your browser a
- To create a new question, simply create a new `*.md` file within this directory, with the pattern of `<YYYY-MM-DD->-<title_of_your_tutorial>.md` being the filename, e.g. `2018-07-24-如何在FydeOS上安装使用Crostini.md`.
- Edit this Markdown file you've just created, with content being the tutorial that you would like to share. Note that the **first two lines of triple dashes** need to be preserved and you should include some metadata to your tutorial in the following format, e.g.

```
---
date: <YYYY-MM-DD>
title: <title to your tutorial, same as the latter part of the filename of this file>
categories:
- <category name of your choice>
type: Document
---
Your tutorial content here
```
```
---
date: <YYYY-MM-DD>
title: <title to your tutorial, same as the latter part of the filename of this file>
categories:
- <category name of your choice>
type: Document
permalink: /<category_name>/<SEO_friendly_title>/
redirect_from:
- /<早期中文category>/<早期中文标题>/
---
Your tutorial content here
```
- Save your file, you should be able to find your item on the Knowledge bsae page.
- When in doubt, you can always refer to existing tutorial files for reference.

Expand Down
6 changes: 5 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ plugins:
- jekyll-sitemap
- jekyll-seo-tag
- jekyll-feed
- jekyll-redirect-from

whitelist:
- jekyll-redirect-from

exclude:
- Gemfile
Expand All @@ -39,7 +43,7 @@ exclude:
- LICENCE

collections:
faq:
faq:
output: true

# jekyll-archives:
Expand Down
8 changes: 6 additions & 2 deletions _posts/2018-07-14-FydeOS for PC安装指南.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
---
date: 2018-07-14
title: FydeOS for PC 安装指南
title: 首次运行 FydeOS for PC
categories:
- 安装教程
- 起步走
type: Document
permalink: /getting-started/fydeos-for-pc/
redirect_from:
- /安装教程/FydeOS-for-PC安装指南/
- /起步走/首次运行FydeOS-for-PC/
---

我们推荐使用 [etcher](https://etcher.io/) 进行 SD 卡的刻录。etcher 是一款帮助用户快速将镜像文件刻录到 USB 设备或闪存卡中的工具软件,并且可以在 Windows、macOS 和主流 Linux 版本等多种操作系统中使用。该软件设计精美,界面友好,相信你马上就能熟知它简单的三部曲操作:
Expand Down
8 changes: 6 additions & 2 deletions _posts/2018-07-15-FydeOS for RPi安装指南.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
---
date: 2018-07-15
title: FydeOS for RPi 安装指南
title: 首次运行 FydeOS for RPi
categories:
- 安装教程
- 起步走
permalink: /getting-started/fydeos-for-rpi/
type: Document
redirect_from:
- /安装教程/FydeOS-for-RPi-安装指南/
- /起步走/首次运行FydeOS-for-RPi/
---

## 极简方式
Expand Down
8 changes: 6 additions & 2 deletions _posts/2018-07-15-FydeOS for TKB安装指南.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
---
date: 2018-07-15
title: FydeOS for TKB 安装指南
title: 首次运行 FydeOS for TKB
categories:
- 安装教程
- 起步走
type: Document
permalink: /getting-started/fydeos-for-tkb/
redirect_from:
- /安装教程/FydeOS-for-TKB-安装指南/
- /起步走/首次运行FydeOS-for-TKB/
---

## 极简方式
Expand Down
3 changes: 3 additions & 0 deletions _posts/2018-07-16-Flint OS for Firefly-RK3288安装指南.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: Flint OS for Firefly-RK3288 安装指南
categories:
- 早期版本
type: Document
permalink: /previous-releases/firefly-rk3288/
redirect_from:
- /早期版本/Flint-OS-for-Firefly-RK3288安装指南/
---
> 注意!早期版本 Flint OS for Firefly-RK3288 需要被烧写到 Firefly-RK3399 的机载高速闪存(eMMC)里才能保证正常稳定运行,这一操作将抹去现 eMMC 里所有的数据且不可逆。如需继续,请事先做好数据备份工作。如需恢复原始系统,请使用官方提供的恢复工具。我们无法对潜在的数据丢失以及安装中可能出现的各种问题负责或者提供及时的技术支持。请三思而后行!

Expand Down
3 changes: 3 additions & 0 deletions _posts/2018-07-16-Flint OS for Firefly-RK3399安装指南.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: Flint OS for Firefly-RK3399 安装指南
categories:
- 早期版本
type: Document
permalink: /previous-releases/firefly-rk3399/
redirect_from:
- /早期版本/Flint-OS-for-Firefly-RK3399安装指南/
---
> 注意!Flint OS 需要被烧写到 Firefly-RK3399 的机载高速闪存(eMMC)里才能保证正常稳定运行,这一操作将抹去现 eMMC 里所有的数据且不可逆。如需继续,请事先做好数据备份工作。如需恢复原始系统,请使用官方提供的恢复工具。我们无法对潜在的数据丢失以及安装中可能出现的各种问题负责或者提供及时的技术支持。请三思而后行!

Expand Down
5 changes: 4 additions & 1 deletion _posts/2018-07-16-将FydeOS for PC安装进硬盘.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
date: 2018-07-16
title: 将 FydeOS for PC 安装进硬盘
categories:
- 使用技巧
- 起步走
type: Document
permalink: /getting-started/install-fydeos-to-hdd/
redirect_from:
- /使用技巧/将FydeOS-for-PC安装进硬盘/
---
>注意!安装 FydeOS 到硬盘上将会抹掉硬盘上所有数据。该功能仍在测试阶段,我们无法对潜在的数据丢失以及安装中可能出现的各种问题负责或者提供及时的技术支持。请三思而后行!

Expand Down
5 changes: 4 additions & 1 deletion _posts/2018-07-30-在FydeOS中进入Shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
date: 2018-07-30
title: 在 FydeOS 中进入 Shell
categories:
- 使用技巧
- 起步走
type: Document
permalink: /getting-started/shell-access/
redirect_from:
- /使用技巧/在FydeOS中进入Shell/
---


Expand Down
3 changes: 3 additions & 0 deletions _posts/2018-07-30-在早期FydeOS版本中启用OTA升级.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: 在早期 FydeOS 版本中启用 OTA 升级
categories:
- 使用技巧
type: Document
permalink: /recipes/enable-ota-in-earlier-fydeos-releases/
redirect_from:
- /使用技巧/在早期FydeOS版本中启用OTA升级/
---

>注意:本教程假设你对 Linux 命令行操作并不陌生且具备最基本的操作技巧。若你觉得以下内容难以理解,请寻求身边朋友的帮助或者采用 [直接烧写](https://fydeos.com/instructions-pc) 的办法升级你的 FydeOS。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: FydeOS 与其它操作系统多启动配置指南
categories:
- 使用技巧
type: Document
permalink: /recipes/dual-boot/
redirect_from:
- /使用技巧/FydeOS与其他操作系统多启动配置指南/
---

> 注意:本教程假设你对 Linux 命令行操作并不陌生且具备最基本的操作技巧。若你觉得以下内容难以理解,请寻求身边朋友的帮助或者到 [FydeOS 中文社区](https://fydeos.com/community) 寻求帮助。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ categories:
- 使用技巧
- crostini
type: Document
permalink: /recipes/enable-crostini-after-ota-update/
redirect_from:
- /使用技巧/crostini/在通过OTA方式升级的FydeOS中开启Linux-测试版/
---

本教程针对通过 OTA 方式升级到 v4.2 及更新版本并且之前未能成功启动 Linux(测试版)的用户。
Expand Down
3 changes: 3 additions & 0 deletions _posts/2018-08-10-如何重置(Powerwash)我的FydeOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: 如何重置(Powerwash)我的 FydeOS
categories:
- 使用技巧
type: Document
permalink: /recipes/powerwash/
redirect_from:
- /使用技巧/如何重置(Powerwash)我的FydeOS/
---

> 该操作的目的是恢复出厂设置并清空所有用户数据,包括但不限于已经安装的浏览器插件、安卓程序、下载文件夹内的数据以及浏览器缓存文件和历史记录等。该操操作执行成功之后结果不可逆,请三思而后行。
Expand Down
3 changes: 3 additions & 0 deletions _posts/2018-08-19-Linux(测试版)设置向导.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ categories:
- 使用技巧
- crostini
type: Document
permalink: /recipes/setting-up-linux-beta/
redirect_from:
- /使用技巧/crostini/Linux-测试版-设置向导/
---

## 1. 什么是 Linux(测试版)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: 如何为 FydeOS 安装方便的软件包管理器
categories:
- 使用技巧
type: Document
permalink: /recipes/chromebrew/
redirect_from:
- /使用技巧/如何为FydeOS安装方便的软件包管理器/
---

## 1.FydeOS 的软件包管理器
Expand Down
3 changes: 3 additions & 0 deletions _posts/2018-09-10-Linux(测试版)升级指导.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ categories:
- 使用技巧
- crostini
type: Document
permalink: /recipes/upgrading-linux-beta/
redirect_from:
- /使用技巧/crostini/Linux-测试版-升级指导/
---

本向导适用于 __同时满足以下两个条件的__ FydeOS 用户
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ categories:
- 使用技巧
- crostini
type: Document
permalink: /recipes/android-development-guide-with-fydeos/
redirect_from:
- /使用技巧/crostini/在FydeOS下开发调试安卓程序指北/
---


Expand Down