From 25d50bfae6aed887a842d917ba5c192c3135562e Mon Sep 17 00:00:00 2001 From: Aiden-Jeon Date: Wed, 1 Dec 2021 17:08:44 +0900 Subject: [PATCH 1/4] update settings and add how to contribute --- README.md | 161 ++++-------------- config/_default/menus/menus.en.toml | 30 ++-- config/_default/params.toml | 25 +-- content/en/docs/help/how-to-contribute.md | 48 ++++-- .../docs/{prologue => introduction}/_index.md | 2 +- .../{prologue => introduction}/example.md | 4 +- content/en/docs/prologue/welcome.md | 2 +- layouts/partials/main/edit-page.html | 4 +- 8 files changed, 97 insertions(+), 179 deletions(-) rename content/en/docs/{prologue => introduction}/_index.md (87%) rename content/en/docs/{prologue => introduction}/example.md (88%) diff --git a/README.md b/README.md index c79c3d35..95321db3 100644 --- a/README.md +++ b/README.md @@ -1,142 +1,43 @@ -

- - Doks - -

- -

- Doks -

- -

- Modern Documentation Theme -

- -

- Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize. -

- -

- - GitHub - - - GitHub release (latest SemVer including pre-releases) - - - npm (scoped) - - - GitHub Workflow Status (branch) - - - Netlify - -

- -![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 +--- +``` diff --git a/config/_default/menus/menus.en.toml b/config/_default/menus/menus.en.toml index 52d6fb0c..1ebac2e3 100644 --- a/config/_default/menus/menus.en.toml +++ b/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 = "" - 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 = "" - url = "https://twitter.com/getdoks" - weight = 20 +# [[social]] +# name = "Twitter" +# pre = "" +# url = "https://twitter.com/getdoks" +# weight = 20 # [[footer]] # name = "Privacy" diff --git a/config/_default/params.toml b/config/_default/params.toml index 56911da3..1eeb21dd 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -3,8 +3,8 @@ ## 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" @@ -12,8 +12,8 @@ description = "Doks is a Hugo theme for building secure, fast, and SEO-ready doc ## 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,9 +24,9 @@ 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 @@ -34,9 +34,9 @@ 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 Netlify, Hugo, and Doks" +# footer = "Powered by Netlify, Hugo, and Doks" +footer = "Powered by Hugo, and Doks" # Feed -copyRight = "Copyright (c) 2020-2021 Henk Verlinde" +copyRight = "Copyright (c) 2021-2022 MLOps for ALL" # Alert alert = false diff --git a/content/en/docs/help/how-to-contribute.md b/content/en/docs/help/how-to-contribute.md index e61ca24f..7774eae6 100644 --- a/content/en/docs/help/how-to-contribute.md +++ b/content/en/docs/help/how-to-contribute.md @@ -1,9 +1,7 @@ --- title: "How to Contribute" -description: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." -lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." -date: 2020-11-12T13:26:54+01:00 -lastmod: 2020-11-12T13:26:54+01:00 +# date: 2020-11-12T13:26:54+01:00 +# lastmod: 2020-11-12T13:26:54+01:00 draft: false images: [] menu: @@ -13,20 +11,44 @@ weight: 1001 toc: true --- -{{< alert icon="💡" text="Learn more about semantic versioning and advanced range syntax." />}} - -## Check for outdated packages +## How to Start +1. 필요한 node module을 설치합니다. +```bash +npm install +``` -The [`npm outdated`](https://docs.npmjs.com/cli/v7/commands/npm-outdated) command will check the registry to see if any (or, specific) installed packages are currently outdated: +2. 글 수정 및 추가를 후 ci 를 실행합니다. +```bash +npm ci +``` +3. node 서버를 실행 후 수정한 글이 정상적으로 나오는지 확인합니다. ```bash -npm outdated [[<@scope>/] ...] +npm run start ``` -## Update packages +## How to Contribute +### 1. 새로운 포스트를 작성하는 경우 +새로운 포스트는 각 챕터와 포스트의 위치에 맞는 weight를 설정합니다. +- Introduction: 1xx +- Setup: 2xx +- Kubeflow: 3xx +- API Deployment: 4xx +- Help: 10xx -The [`npm update`](https://docs.npmjs.com/cli/v7/commands/npm-update) command will update all the packages listed to the latest version (specified by the tag config), respecting semver: +### 2. 기존의 포스트를 수정하는 경우 +기존의 포스트를 수정할 경우 Contributor에 본인의 이름을 입력합니다. +``` +contributors: ["John Doe", "Adam Smith"] +``` -```bash -npm update [...] +### 3. 프로젝트에 처음 기여하는 경우 +만약 프로젝트에 처음 기여 할 경우 `content/en/contributors`에 본인의 이름의 마크다운 파일을 작성합니다. +마크다운 파일은 `john-doe`을 파일명으로 하며 다음의 내용을 작성합니다. +파일 명은 lowercase를 title은 upper camelcase를 이용해 작성합니다. +``` +--- +title: "Jonh Doe" +draft: false +--- ``` diff --git a/content/en/docs/prologue/_index.md b/content/en/docs/introduction/_index.md similarity index 87% rename from content/en/docs/prologue/_index.md rename to content/en/docs/introduction/_index.md index bb43512b..98a85c0b 100644 --- a/content/en/docs/prologue/_index.md +++ b/content/en/docs/introduction/_index.md @@ -1,5 +1,5 @@ --- -title : "Prologue" +title : "Introduction" description: "Introduction to MLOps" lead: "" # date: 2020-10-06T08:48:23+00:00 diff --git a/content/en/docs/prologue/example.md b/content/en/docs/introduction/example.md similarity index 88% rename from content/en/docs/prologue/example.md rename to content/en/docs/introduction/example.md index 8a3a46dc..1995b818 100644 --- a/content/en/docs/prologue/example.md +++ b/content/en/docs/introduction/example.md @@ -5,11 +5,11 @@ lead: "" # date: 2020-10-06T08:48:23+00:00 # lastmod: 2020-10-06T08:48:23+00:00 draft: false -weight: 102 +weight: 101 contributors: ["Jongseob Jeon"] menu: docs: - parent: "prologue" + parent: "introduction" images: [] --- diff --git a/content/en/docs/prologue/welcome.md b/content/en/docs/prologue/welcome.md index fbdea68f..546026f6 100644 --- a/content/en/docs/prologue/welcome.md +++ b/content/en/docs/prologue/welcome.md @@ -6,7 +6,7 @@ lead: "" # lastmod: 2020-10-06T08:48:23+00:00 draft: false images: [] -weight: 101 +weight: 1 menu: docs: parent: "prologue" diff --git a/layouts/partials/main/edit-page.html b/layouts/partials/main/edit-page.html index e8c901a4..dd1aece7 100644 --- a/layouts/partials/main/edit-page.html +++ b/layouts/partials/main/edit-page.html @@ -9,7 +9,7 @@ {{ $editPath = "/-/blob/" }} {{ end }} -{{ $contentPath := print .Site.Params.docsRepo $editPath .Site.Params.docsRepoBranch "/content/" }} +{{ $contentPath := print .Site.Params.docsRepo $editPath .Site.Params.docsRepoBranch "/content/en/" }} {{ $url := print $contentPath $filePath }} @@ -19,7 +19,7 @@

- + Edit this page on {{ .Site.Params.repoHost }} From b53eb68e6d3da54963b8d3bc948dd912a72f2008 Mon Sep 17 00:00:00 2001 From: Aiden-Jeon Date: Wed, 1 Dec 2021 17:15:33 +0900 Subject: [PATCH 2/4] update LICENSE --- LICENSE | 2 +- layouts/index.html | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/LICENSE b/LICENSE index a9431aad..a6f08e38 100644 --- a/LICENSE +++ b/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 diff --git a/layouts/index.html b/layouts/index.html index 67fc956d..0e638b25 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -7,7 +7,8 @@

{{ .Title }}

{{ .Params.lead | safeHTML }}

Get Started -

Open-source MIT Licensed. GitHub v{{ $data := getJSON "/package.json" }}{{ $data.version }}

+ +

Open-source MIT Licensed.

From 4fc43ad9ba2969611c5382b20282cce8eb450695 Mon Sep 17 00:00:00 2001 From: Aiden-Jeon Date: Wed, 1 Dec 2021 17:17:23 +0900 Subject: [PATCH 3/4] add ci for page --- .github/workflows/gh-pages.yml | 2 +- .github/workflows/page-ci.yml | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/page-ci.yml diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 8779e3ca..de2ca4de 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -1,4 +1,4 @@ -name: github pages +name: CD for github pages on: push: diff --git a/.github/workflows/page-ci.yml b/.github/workflows/page-ci.yml new file mode 100644 index 00000000..a620b060 --- /dev/null +++ b/.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 From 85e69b29875a11df921efad1c0c5c1458024853a Mon Sep 17 00:00:00 2001 From: Aiden-Jeon Date: Wed, 1 Dec 2021 17:28:59 +0900 Subject: [PATCH 4/4] fix md lint --- .markdownlint.json | 5 ++--- content/en/docs/help/how-to-contribute.md | 15 +++++++++++++-- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/.markdownlint.json b/.markdownlint.json index a8b885d0..5879dc35 100644 --- a/.markdownlint.json +++ b/.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 } \ No newline at end of file diff --git a/content/en/docs/help/how-to-contribute.md b/content/en/docs/help/how-to-contribute.md index 7774eae6..b7db0c30 100644 --- a/content/en/docs/help/how-to-contribute.md +++ b/content/en/docs/help/how-to-contribute.md @@ -12,24 +12,31 @@ toc: true --- ## How to Start + 1. 필요한 node module을 설치합니다. + ```bash npm install ``` 2. 글 수정 및 추가를 후 ci 를 실행합니다. + ```bash npm ci ``` 3. node 서버를 실행 후 수정한 글이 정상적으로 나오는지 확인합니다. + ```bash npm run start ``` ## How to Contribute + ### 1. 새로운 포스트를 작성하는 경우 + 새로운 포스트는 각 챕터와 포스트의 위치에 맞는 weight를 설정합니다. + - Introduction: 1xx - Setup: 2xx - Kubeflow: 3xx @@ -37,16 +44,20 @@ npm run start - Help: 10xx ### 2. 기존의 포스트를 수정하는 경우 + 기존의 포스트를 수정할 경우 Contributor에 본인의 이름을 입력합니다. -``` + +```markdown contributors: ["John Doe", "Adam Smith"] ``` ### 3. 프로젝트에 처음 기여하는 경우 + 만약 프로젝트에 처음 기여 할 경우 `content/en/contributors`에 본인의 이름의 마크다운 파일을 작성합니다. 마크다운 파일은 `john-doe`을 파일명으로 하며 다음의 내용을 작성합니다. 파일 명은 lowercase를 title은 upper camelcase를 이용해 작성합니다. -``` + +```markdown --- title: "Jonh Doe" draft: false