[Enhance] Initial Repo Setup

.github/workflows/gh-pages.yml

@@ -1,4 +1,4 @@
-name: github pages
+name: CD for github pages
 
 on:
   push:

.github/workflows/page-ci.yml

@@ -0,0 +1,23 @@
+name: CI for github pages
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "17"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run test script
+        run: npm test

.markdownlint.json

@@ -1,10 +1,9 @@
 {
-  "comment": "Hyas rules",
-
   "default": true,
   "line_length": false,
   "no-inline-html": false,
   "no-trailing-punctuation": false,
   "no-duplicate-heading": false,
-  "no-bare-urls": false
+  "no-bare-urls": false,
+  "MD029": false
 }

LICENSE

@@ -1,7 +1,7 @@
 MIT License
 
 Copyright (c) 2018-present, Gridsome
-Copyright (c) 2020-present, Henk Verlinde
+Copyright 2021-presetn MLOps for ALL
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,142 +1,43 @@
-<p align="center">
-  <a href="https://getdoks.org/">
-    <img alt="Doks" src="https://doks.netlify.app/doks.svg" width="60">
-  </a>
-</p>
-
-<h1 align="center">
-  Doks
-</h1>
-
-<h3 align="center">
-  Modern Documentation Theme
-</h3>
-
-<p align="center">
-  Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
-</p>
-
-<p align="center">
-  <a href="https://github.com/h-enk/doks/blob/master/LICENSE">
-    <img src="https://img.shields.io/github/license/h-enk/doks?style=flat-square" alt="GitHub">
-  </a>
-  <a href="https://github.com/h-enk/doks/releases">
-    <img src="https://img.shields.io/github/v/release/h-enk/doks?include_prereleases&style=flat-square"alt="GitHub release (latest SemVer including pre-releases)">
-  </a>
-  <a href="https://www.npmjs.com/package/@hyas/doks">
-    <img src="https://img.shields.io/npm/v/@hyas/doks?style=flat-square" alt="npm (scoped)">
-  </a>
-  <a href="https://github.com/h-enk/doks/actions?query=workflow%3A%22Hyas+CI%22">
-    <img src="https://img.shields.io/github/workflow/status/h-enk/doks/Hyas%20CI/master?style=flat-square" alt="GitHub Workflow Status (branch)">
-  </a>
-  <a href="https://app.netlify.com/sites/doks/deploys">
-    <img src="https://img.shields.io/netlify/8a1009d5-88ac-413e-96ef-3f928674a083?style=flat-square" alt="Netlify">
-  </a>
-</p>
-
-![Doks — Modern Documentation Theme](https://raw.githubusercontent.com/h-enk/doks/master/images/tn.png)
-
-## Demo
-
-- [doks.netlify.app](https://doks.netlify.app/)
-
-## Why Doks?
-
-Nine main reasons why you should use Doks:
-
-1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.netlify.app) out of the box. Easily change the default Security Headers to suit your needs.
-
-2. __Fast by default__. Get 100 scores on [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637) by default. Doks removes unused css, prefetches links, and lazy loads images.
-
-3. __SEO-ready__. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.
-
-4. __Development tools__. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.
-
-5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files.
-
-6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.
-
-7. __Full text search__. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.
-
-8. __Page layouts__. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.
-
-9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.
-
-### Other features
-
-- __Multilingual and i18n__ support
-- __Versioning__ documentation support
-- __KaTeX__ math typesetting
-- __Mermaid__ diagrams and visualization
-- __highlight.js__ syntax highlighting
-
-## Requirements
-
-Doks uses npm to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts:
-
-- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform.
-
-## Get started
-
-Start a new Doks project in three steps:
-
-### 1. Create a new site
-
-Doks is available as a child theme, and a starter theme:
-
-- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates.
-- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates.
-
-Not quite sure? Use the Doks child theme.
-
-#### Doks child theme
+## 모두의 MLOps
 
+### How to Start
+1. 필요한 node module을 설치합니다.
 ```bash
-git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site
-```
-
-#### Doks starter theme
-
-```bash
-git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site
+npm install
 ```
 
-### 2. Install dependencies
-
+2. 글 수정 및 추가를 후 ci 를 실행합니다.
 ```bash
-npm install
+npm ci
 ```
 
-### 3. Start development server
-
+3. node 서버를 실행 후 수정한 글이 정상적으로 나오는지 확인합니다.
 ```bash
 npm run start
 ```
 
-## Other commands
-
-Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks.
-
-## Documentation
-
-- [Netlify](https://docs.netlify.com/)
-- [Hugo](https://gohugo.io/documentation/)
-- [Doks](https://getdoks.org/)
-
-## Communities
-
-- [Netlify Community](https://community.netlify.com/)
-- [Hugo Forums](https://discourse.gohugo.io/)
-- [Doks Discussions](https://github.com/h-enk/doks/discussions)
-
-## Sponsors
-
-Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/doks)]
-
-[![OC sponsor 0](https://opencollective.com/doks/sponsor/0/avatar.svg)](https://opencollective.com/doks/sponsor/0/website)
-
-## Backers
-
-Support this project by becoming a backer. Your avatar will show up here. [[Become a backer](https://opencollective.com/doks)]
+### How to Contribute
+#### 1. 새로운 포스트를 작성하는 경우
+새로운 포스트는 각 챕터와 포스트의 위치에 맞는 weight를 설정합니다.
+- Introduction: 1xx
+- Setup: 2xx
+- Kubeflow: 3xx
+- API Deployment: 4xx
+- Help: 10xx
+
+#### 2. 기존의 포스트를 수정하는 경우
+기존의 포스트를 수정할 경우 Contributor에 본인의 이름을 입력합니다.
+```
+contributors: ["John Doe", "Adam Smith"]
+```
 
-[![Backers](https://opencollective.com/doks/backers.svg)](https://opencollective.com/doks)
+#### 3. 프로젝트에 처음 기여하는 경우
+만약 프로젝트에 처음 기여 할 경우 `content/en/contributors`에 본인의 이름의 마크다운 파일을 작성합니다.
+마크다운 파일은 `john-doe`을 파일명으로 하며 다음의 내용을 작성합니다.
+파일 명은 lowercase를 title은 upper camelcase를 이용해 작성합니다.
+```
+---
+title: "Jonh Doe"
+draft: false
+---
+```

config/_default/menus/menus.en.toml

@@ -1,15 +1,3 @@
-# [[docs]]
-#   name = "Prologue"
-#   weight = 10
-#   identifier = "prologue"
-#   url = "/docs/prologue/"
-
-# [[docs]]
-#   name = "Help"
-#   weight = 60
-#   identifier = "help"
-#   url = "/docs/help/"
-
 [[main]]
   name = "Docs"
   url = "/docs/prologue/welcome/"
@@ -30,6 +18,12 @@
   name = "Prologue"
   url = "/docs/prologue/"
   identifier = "prologue"
+  weight = 1
+
+[[docs]]
+  name = "Introduction"
+  url = "/docs/introduction/"
+  identifier = "introduction"
   weight = 10
 
 [[docs]]
@@ -53,15 +47,15 @@
 [[social]]
   name = "GitHub"
   pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-github\"><path d=\"M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22\"></path></svg>"
-  url = "https://github.com/h-enk/doks"
+  url = "https://github.com/mlops-for-all/mlops-for-all.github.io"
   post = "v0.1.0"
   weight = 10
 
-[[social]]
-  name = "Twitter"
-  pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>"
-  url = "https://twitter.com/getdoks"
-  weight = 20
+# [[social]]
+#   name = "Twitter"
+#   pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>"
+#   url = "https://twitter.com/getdoks"
+#   weight = 20
 
 # [[footer]]
 #   name = "Privacy"

config/_default/params.toml

@@ -3,17 +3,17 @@
 ## Homepage
 title = "모두의 MLOps"
 titleSeparator = "-"
-titleAddition = "Modern Documentation Theme"
-description = "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
+titleAddition = "모두가 쉽게 시작할 수 있는 MLOps"
+description = "모두가 쉽게 시작할 수 있는 MLOps 자료를 제작합니다."
 
 ## Documentation
 # docsVersion = "0.3"
 
 ## Open Graph
 images = ["doks.png"]
 ogLocale = "en_US"
-domainTLD = "doks.netlify.app"
-titleHome = "Doks Theme"
+domainTLD = "mlops-for-all.netlify.app"
+titleHome = "MLOps for ALL"
 
 ## Twitter Cards
 # twitterSite = "@getdoks"
@@ -24,19 +24,19 @@ titleHome = "Doks Theme"
 schemaType = "Organization"
 schemaName = "Doks"
 schemaAuthor = "Henk Verlinde"
-schemaAuthorTwitter = "https://twitter.com/henkverlinde"
-schemaAuthorLinkedIn = "https://www.linkedin.com/in/henkverlinde/"
-schemaAuthorGitHub = "https://github.com/h-enk"
+# schemaAuthorTwitter = "https://twitter.com/henkverlinde"
+# schemaAuthorLinkedIn = "https://www.linkedin.com/in/henkverlinde/"
+schemaAuthorGitHub = "https://github.com/mlops-for-all"
 schemaLocale = "en-US"
 schemaLogo = "logo-doks.png"
 schemaLogoWidth = 512
 schemaLogoHeight = 512
 schemaImage = "doks.png"
 schemaImageWidth = 1280
 schemaImageHeight = 640
-schemaTwitter = "https://twitter.com/getdoks"
-schemaLinkedIn = ""
-schemaGitHub = "https://github.com/h-enk/doks"
+# schemaTwitter = "https://twitter.com/getdoks"
+# schemaLinkedIn = ""
+schemaGitHub = "https://github.com/mlops-for-all/mlops-for-all.github.io"
 schemaSection = "blog"
 
 ## Sitelinks Search Box
@@ -54,10 +54,11 @@ lqipWidth = "20x"
 smallLimit = "300"
 
 # Footer
-footer = "Powered by <a href=\"https://www.netlify.com/\">Netlify</a>, <a href=\"https://gohugo.io/\">Hugo</a>, and <a href=\"https://getdoks.org/\">Doks</a>"
+# footer = "Powered by <a href=\"https://www.netlify.com/\">Netlify</a>, <a href=\"https://gohugo.io/\">Hugo</a>, and <a href=\"https://getdoks.org/\">Doks</a>"
+footer = "Powered by <a href=\"https://gohugo.io/\">Hugo</a>, and <a href=\"https://getdoks.org/\">Doks</a>"
 
 # Feed
-copyRight = "Copyright (c) 2020-2021 Henk Verlinde"
+copyRight = "Copyright (c) 2021-2022 MLOps for ALL"
 
 # Alert
 alert = false