Skip to content

Commit

Permalink
chagne sidebar to index
Browse files Browse the repository at this point in the history
  • Loading branch information
gy2006 committed Jan 11, 2022
1 parent 29f6b4a commit e286e07
Show file tree
Hide file tree
Showing 11 changed files with 60 additions and 225 deletions.
78 changes: 0 additions & 78 deletions README.md

This file was deleted.

15 changes: 1 addition & 14 deletions cf_docker.md
Original file line number Diff line number Diff line change
@@ -1,14 +1 @@
# Insall flow.ci from docker

[Docker](https://docs.docker.com/install/) & [Docker-Compose](https://docs.docker.com/compose/install/) are required


Just run the following command

```bash
git clone https://github.com/FlowCI/docker.git flow-docker
cd flow-docker
./server.sh start
```

![](./v1.0/img/start_server.gif)
更多信息,请访问 [flow.ci](https://flowci.github.io)
4 changes: 1 addition & 3 deletions cf_linux.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# Insall flow.ci from linux

> Document not ready yet, we recommand install it by docker, please follow the document [first build](./v1.0/start/index.md)
更多信息,请访问 [flow.ci](https://flowci.github.io)
4 changes: 1 addition & 3 deletions cf_osx.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# Insall flow.ci from Mac OS

> Document not ready yet, we recommand install it by docker, please follow the document [first build](./v1.0/start/index.md)
更多信息,请访问 [flow.ci](https://flowci.github.io)
2 changes: 1 addition & 1 deletion cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ cd flow-docker

## 帮助

如果需要帮助? 从[这里]提交问题 (https://github.com/FlowCI/docs/issues) 或发送邮件至 `[email protected]`
如果需要帮助? 从[这里](https://github.com/FlowCI/docs/issues) 提交问题 或发送邮件至 `[email protected]`


## 构建模板
Expand Down
File renamed without changes.
4 changes: 1 addition & 3 deletions en/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,7 @@ cd flow-docker
./server.sh start
```

## Documentation

+ [English](https://github.com/FlowCI/docs/tree/master/en/index.md)
## Help

Need Help? submit issue from [here](https://github.com/FlowCI/docs/issues) or send email to `[email protected]`

Expand Down
56 changes: 0 additions & 56 deletions en/_sidebar.md

This file was deleted.

84 changes: 52 additions & 32 deletions en/index.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,56 @@
# Table of contents

* Getting Started
* [First Build](./start/index.md)

* [Link to Git](./git/index.md)
* [Github](./git/github.md)
* [Gitlab](./git/gitlab.md)
* [Gogs](./git/gogs.md)
* [Gitee](./git/gitee.md)

* YAML
* [Reference](./yml/reference_v1.md)
* [Plugins](./yml/plugins.md)
* [Templates](https://github.com/FlowCI/templates)

* Agents
* Manual Agents
* [Linux](./agents/manual.md)
* [MacOS](./agents/manual.md)
* [Windows](./agents/manual.md)
* [Docker](./agents/manual.md)
* Dynamic Agents
* [Host via SSH](./agents/ssh_host.md)
* [In K8s Cluster](./agents/k8s_host.md)
* [Environment Variables](./agents/vars.md)

* Quick Start
* [Install](en/start/index.md#Install)
* [Set URL](en/start/index.md#set-server-url)
* [Create a flow](en/start/index.md#create-a-flow)
* [Run](en/start/index.md#run)

* Flow
* [Structure](en/flow/structure.md#flow-structure)

* Job
* [Start](en/job/start.md)
* [Workspace](en/job/workspace.md)
* [Condition](en/job/condition.md)
* [Environment with Docker](en/job/docker.md)
* [Parallel](en/job/parallel.md)
* [Cache](en/job/cache.md)
* [Crontab](en/job/schedule.md)
* [Web Terminal](en/job/web_terminal.md)

* Git Connection
* [Git setup](en/git/index.md)
* [Link to Github](en/git/github.md)
* [Link to Gitlab](en/git/gitlab.md)
* [Link to Gogs](en/git/gogs.md)
* [Link to Gitee](en/git/gitee.md)

* Agent
* [What is Agent](en/agents/index.md)
* [Add Agent](en/agents/manual.md)
* Auto Scaling
* [Kubernates](en/agents/k8s_host.md)
* [SSH Host](en/agents/ssh_host.md)

* Secret
* [SSH-RSA](./secret/ssh-rsa.md)
* [Auth (username and password)](./secret/auth.md)
* [Token](./secret/token.md)
* [Android Sign](./secret/android_sign.md)
* [SSH-RSA](en/secret/ssh-rsa.md)
* [Auth](en/secret/auth.md)
* [Token](en/secret/token.md)
* [Android Sign](en/secret/android_sign.md)
* [K8s kubeconfig](en/secret/kubeconfig.md)


* Config
* [SMTP](./config/smtp.md)
* [Text](./config/text.md)
* [SMTP](en/config/smtp.md)
* [Free Text](en/config/freetext.md)

* Trigger
* [`OnJobFinish` Event](en/trigger/on_job_finish.md)
- [Email Trigger](en/trigger/on_job_finish.md#send-email)
- [Webhook Trigger](en/trigger/on_job_finish.md#send-http-request)

* Plugins

* Reference
* [YAML](en/yml/reference_v1.md)
* [Variables](en/agents/vars.md)
3 changes: 2 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@
repo: 'https://github.com/flowci/flow-core-x',
loadSidebar: true,
themeColor: '#5C53C4FF',
loadSidebar: 'index.md',
alias: {
'/_sidebar.md': '/en/_sidebar.md'
'/index.md': '/en/index.md'
}
}
</script>
Expand Down
35 changes: 1 addition & 34 deletions intro_base.md
Original file line number Diff line number Diff line change
@@ -1,34 +1 @@
# Getting Started [快速开始](./zh/start/index.md)

## 1. Install

> [Docker](https://docs.docker.com/install/) & [Docker-Compose](https://docs.docker.com/compose/install/) are required
To install flow.ci, just run the following script:

```bash
git clone https://github.com/FlowCI/docker.git flow-docker
cd flow-docker
./server.sh start
```

Open the link `http://localhost:2015` from web browser after installtion is finished.

![cmd](./src/start_server.gif)

## 2. Create a flow

- Input flow name
- Click 'create flow' button
- Input name of flow

- Select YAML template

## 3. First build

Click `Run` button from flow page

> - Job cannot started if the blank template has been selected.
> - How to config Git repo, please refer to [Link to Git](./en/git/index.md)
![start](./src/create_flow_and_build.gif)
For more information, please check [flow.ci](https://flowci.github.io)

0 comments on commit e286e07

Please sign in to comment.