Git Product home page Git Product logo

note's Introduction

使用手册

本文档记录使用操作指南,文档中的template是指目录docs/template,示例:建立一个Flume模块的文档

1.template文件目录结构

|-----------------docs(文件夹)
|    |-----template基本使用(文件夹)
|    |    |-----001.文档一.md
|    |    |-----002.文档二.md
|    |-----template源码学习(文件夹)
|    |    |-----001.文档一.md
|    |    |-----002.文档二.md
|    |-----_sidebar.md
|    |-----README.md
  • _sidebar.md 是进入到template模块下的侧边栏
  • README.md 是进入到这个模块的首页显示页面

2.复制template文件夹

  • 复制template,将其修改成将要修改的名称如:Flume
  • 将子文件中的 template基本使用 重命名为 Flume-ng基本使用
  • 将子文件中的 template源码学习 重命名为 Flume-ng源码学习

3.修改侧边栏

  • 修改_sidebar.md文件,将编写好的目录指定相关的md文件,如:

    * **Flume-ng**
      * **Flume-ng基本使用**
        * [(一)安装部署](docs/大数据/Flume/Flume-ng基本使用/001.安装部署.md)
    	* [(二)利用tail来采集数据到HDFS](docs/大数据/Flume/Flume-ng基本使用/002.利用tail来采集数据到HDFS.md)
        * [(三)自定义Source](docs/大数据/Flume/Flume-ng基本使用/003.自定义Source.md)
        * [(四)自定义Sink](docs/大数据/Flume/Flume-ng基本使用/004.自定义Sink.md)
        * [(五)自定义Intercetor](docs/大数据/Flume/Flume-ng基本使用/005.自定义Intercetor.md)		
      * **Flume-ng源码学习** 
        * [(一)入口程序启动分析](docs/大数据/Flume/Flume-ng源码/01.入口程序启动分析.md)
        * [(二)Source组件分析](docs/大数据/Flume/Flume-ng源码/02.Source组件.md)
        * [(三)avroSource分析](docs/大数据/Flume/Flume-ng源码/03.avroSource.md)
        * [(四)Channel组件分析](docs/大数据/Flume/Flume-ng源码/04.Channel组件.md)
        * [(五)FileChannel分析](docs/大数据/Flume/Flume-ng源码/05.FileChannel.md)
        * [(六)MemoryChannel分析](docs/大数据/Flume/Flume-ng源码/06.MemoryChannel.md)
        * [(七)Sink组件析](docs/大数据/Flume/Flume-ng源码/07.Sink组件.md)
        * [(八)avroSink分析](docs/大数据/Flume/Flume-ng源码/08.avroSink.md)
        * [(九)hdfsSink分析](docs/大数据/Flume/Flume-ng源码/09.hdfsSink.md)
        * [(十)kafkaSink分析](docs/大数据/Flume/Flume-ng源码/10.kafkaSink.md)
        * [(十一)拦截器Interceptor分析](docs/大数据/Flume/Flume-ng源码/11.拦截器Interceptor.md)

    大标题 : Flume-ng

    小标题 : Flume-ng基本使用

    指定标题与md文档关系 :* (一)安装部署

4.修改README.md

​ 进入到目录要显示的内容,可以填写简介。

5.指定导航栏路径

​ 修改根目录下的_navbar.md文件,指定路径

* 大数据
  * [Flume](/docs/大数据/Flume/README.md)
  * [Kafka](/docs/大数据/Kafka/README.md)

Flume指定到/docs/大数据/Flume/README.md路径

6.部署到githup

将本docsify代码提交到githup,打开githup page功能,如用域名访问必须提交域名文件。

note's People

Contributors

939598604 avatar

Watchers

James Cloos avatar  avatar

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.