sync with dvc.org (#83)

* major sync with dvc.org * Update yarn.lock * Fix broken link on docs index Co-authored-by: rogermparent <[email protected]>
iterative · Aug 17, 2021 · 66362c6 · 66362c6
1 parent 22de500
commit 66362c6
Show file tree

Hide file tree

Showing 14 changed files with 85 additions and 65 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,2 +1,2 @@
 **Please see our contributing guide at
-[dvc.org](https://dvc.org/doc/user-guide/contributing/docs).**
+[cml.dev](https://cml.dev/doc/contributing/docs).**
diff --git a/.github/workflows/link-check-all.yml b/.github/workflows/link-check-all.yml
@@ -3,19 +3,16 @@ on:
   workflow_dispatch:
   schedule:
     - cron: '0 0 * * *'
-
 jobs:
   run:
     name: Link Check All
     runs-on: ubuntu-latest
     env:
       NODE_OPTIONS: '--max-http-header-size=65536'
-
     steps:
       - uses: actions/checkout@v2
-
       - name: Run Link Check
-        uses: 'iterative/link-check.action@v0.7'
+        uses: 'iterative/link-check.action@v0.8'
         with:
           configFile: 'config/link-check/config.yml'
           output: consoleLog
diff --git a/.github/workflows/link-check-deploy.yml b/.github/workflows/link-check-deploy.yml
@@ -4,32 +4,29 @@ name: Check new links against deployment
 on:
   - deployment
   - deployment_status
-
 jobs:
   run:
     name: Initialize
     runs-on: ubuntu-latest
-    if: github.event.deployment.ref != 'master' && github.event.deployment_status.state == 'success'
-
+    if:
+      github.event.deployment.ref != 'master' &&
+      github.event.deployment_status.state == 'success'
     steps:
       - uses: actions/checkout@v2
-
       - id: build_check
         uses: LouisBrunner/[email protected]
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           name: Report
           status: queued
-
       - name: Run Link Check
         id: check
-        uses: 'iterative/link-check.action@v0.7'
+        uses: iterative/link-check.action@v0.8
         with:
           diff: true
-          configFile: 'config/link-check/config.yml'
+          configFile: config/link-check/config.yml
           rootURL: '${{ github.event.deployment.payload.web_url }}'
           output: checksAction
-
       - uses: LouisBrunner/[email protected]
         if: ${{ success() }}
         with:
@@ -38,7 +35,6 @@ jobs:
           status: completed
           conclusion: ${{ steps.check.outputs.conclusion }}
           output: ${{ steps.check.outputs.output }}
-
       - uses: LouisBrunner/[email protected]
         if: ${{ failure() }}
         with:

diff --git a/.prettierignore b/.prettierignore
@@ -1,4 +1,4 @@
 .cache/
-.github
 public/
+.github/PULL_REQUEST_TEMPLATE.md
 src/components/pages/Home/UseCasesSection/index.tsx
diff --git a/.restyled.yaml b/.restyled.yaml
@@ -10,10 +10,6 @@ restylers:
         '--print-width=80',
         '--tab-width=2',
         '--use-tabs=false',
-        '--prose-wrap=always',
+        '--prose-wrap=always'
       ]
-    include:
-      - './*.{js,md}'
-      - 'pages/**/*.js'
-      - 'content/**/*.md'
-      - 'src/**/*.js'
+    include: ['**/*.{js,json,md,yaml,yml}']
diff --git a/README.md b/README.md
@@ -1,34 +1,45 @@
-# CML website
+![CML](https://static.iterative.ai/img/title_strip_trim.svg)
 
-This repo hosts the Gatsby-based website for
-[CML](https://github.com/iterative/cml).
+[![CircleCI](https://circleci.com/gh/iterative/cml.dev.svg?style=svg)](https://circleci.com/gh/iterative/cml.dev)
+[![Link Check](https://github.com/iterative/cml.dev/workflows/Check%20all%20links%20in%20the%20repository/badge.svg)](https://github.com/iterative/cml.dev/actions?query=workflow%3A%22Check+all+links+in+the+repository%22)
 
-It's primarily a marketing website with some light docs, but the primary docs
-are in the GitHub README.
+[CML](https://github.com/iterative/cml) project website's source code.
+[Documentation](https://cml.dev/doc) content. Contributions are welcome!
 
-## Running this site locally
+# Contributing Docs
 
-Start by cloning this repo:
+Please see our [Contributing guide](https://cml.dev/doc/contributing/docs) for
+more details.
 
-Get the full history with
+## Running this site locally
 
 ```bash
 git clone https://github.com/iterative/cml.dev
-```
-
-Alternatively, you can save some space with a shallow clone:
-
-```bash
-git clone --depth 1 https://github.com/iterative/cml.dev
-```
-
-From here, go into the cloned directory and install packages
-
-```bash
+# Alternatively, save space with a shallow clone:
+# git clone --depth 1 https://github.com/iterative/cml.dev
 cd cml.dev
+# Install dependencies
 yarn
 ```
 
 With the setup finished, you can now spin up the development server at
 `localhost:8000` with `gatsby develop` or try a full local build at
 `localhost:9000` with `gatsby build && gatsby serve`.
+
+# Getting help
+
+If you have any questions, please join the [community](https://cml.dev/chat) and
+use the `#dev-docs` channel to discuss any issues in our website or docs. We are
+very responsive and happy to help.
+
+# Copyright
+
+Source code of this project is distributed under the Apache license version 2.0
+(see the LICENSE file in the project root).
+
+Except where otherwise noted, documentation, blog content, images are licensed
+under a [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) license.
+
+By submitting a pull request for this project, you agree to license your
+contribution under the Apache license 2.0 (source code) or CC BY 4.0
+(documentation). Exceptions could be made to content.
diff --git a/config/link-check/config.yml b/config/link-check/config.yml
@@ -1,2 +1,8 @@
+rootURL: https://cml.dev
 fileIncludePatterns: '{.github,content,src}/**/*!(.test).{css,js,jsx,md,tsx,ts,json}'
 fileExcludePatternFile: config/link-check/excluded-files.yml
+linkExcludePatternFile: config/link-check/excluded-links.yml
+linkOptions:
+  '(*.)?github.com':
+    minTime: 1000
+    maxConcurrent: 1
diff --git a/config/link-check/excluded-links.yml b/config/link-check/excluded-links.yml
@@ -0,0 +1,2 @@
+- 'http://localhost:8000**'
+- 'http://localhost:9000**'
diff --git a/content/docs/index.md b/content/docs/index.md
@@ -33,4 +33,5 @@ specific help. We are very responsive ⚡.
 ✅ Check out our [GitHub repository](https://github.com/iterative/cml) and give
 us a ⭐ if you like the project!
 
-✅ Contribute to DVC [on GitHub](https://github.com/iterative/cml) 🙏.
+✅ Contribute to DVC [on GitHub](https://github.com/iterative/cml) or help us
+improve this [documentation](https://github.com/iterative/cml.dev) 🙏.
diff --git a/content/docs/self-hosted-runners.md b/content/docs/self-hosted-runners.md
@@ -25,7 +25,7 @@ environmental variables for passing your cloud service credentials to the
 workflow.
 
 ```yaml
-name: "Train-in-the-cloud"
+name: 'Train-in-the-cloud'
 on: [push]
 
 jobs:
@@ -34,7 +34,7 @@ jobs:
     steps:
       - uses: iterative/setup-cml@v1
       - uses: actions/checkout@v2
-      - name: "Deploy runner on EC2"
+      - name: 'Deploy runner on EC2'
         shell: bash
         env:
           repo_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
@@ -46,22 +46,22 @@ jobs:
           --cloud-region us-west \
           --cloud-type=t2.micro \
           --labels=cml-runner
-  name: model-training
+  model-training:
     needs: deploy-runner
-    runs-on: [self-hosted,cml-runner]
+    runs-on: [self-hosted, cml-runner]
     container: docker://dvcorg/cml-py3:latest
     steps:
-    - uses: actions/checkout@v2
-    - name: "Train my model"
-      env:
-        repo_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-      run: |
-        pip install -r requirements.txt
-        python train.py
-
-        # Publish report with CML
-        cat metrics.txt > report.md
-        cml-send-comment report.md
+      - uses: actions/checkout@v2
+      - name: 'Train my model'
+        env:
+          repo_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+        run: |
+          pip install -r requirements.txt
+          python train.py
+
+          # Publish report with CML
+          cat metrics.txt > report.md
+          cml-send-comment report.md
 ```
 
 In the above workflow, the step `deploy-runner` launches an EC2 `t2-micro`

diff --git a/gatsby-config.js b/gatsby-config.js
@@ -8,9 +8,19 @@ require('./config/prismjs/usage')
 const apiMiddleware = require('./src/server/middleware/api')
 const redirectsMiddleware = require('./src/server/middleware/redirects')
 
-const title = 'CML - Continuous Machine Learning: Bring DevOps to Data Science'
+const title = 'CML · Continuous Machine Learning'
 const description =
-  'CML is continuous integration for machine learning.  Bring DevOps practices to your projects for automatic, reproducible, and fast machine learning.'
+  'Bring DevOps practices to your projects for automatic, reproducible, and fast machine learning.'
+
+const keywords = [
+  'continuous machine learning',
+  'machine learning',
+  'continuous integration',
+  'continuous delivery',
+  'devops',
+  'deployment',
+  'provisioning'
+]
 
 const plugins = [
   {
@@ -185,8 +195,9 @@ module.exports = {
   plugins,
   siteMetadata: {
     description,
-    author: `Iterative`,
-    siteUrl: process.env.URL || 'https://cml.dev',
+    author: 'Iterative',
+    keywords,
+    siteUrl: 'https://cml.dev',
     title
   },
   developMiddleware: app => {

diff --git a/package.json b/package.json
@@ -23,12 +23,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/gatsbyjs/cml.dev"
+    "url": "https://github.com/iterative/cml.dev"
   },
   "author": "",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/gatsbyjs/gatsby/issues"
+    "url": "https://github.com/iterative/cml.dev/issues"
   },
   "homepage": "https://github.com/iterative/cml.dev#readme",
   "engines": {
@@ -70,7 +70,7 @@
     "node-cache": "^5.1.0",
     "perfect-scrollbar": "^1.5.0",
     "pretty-quick": "^2.0.1",
-    "prismjs": "^1.23.0",
+    "prismjs": "^1.24.0",
     "promise-polyfill": "^8.1.3",
     "prop-types": "^15.7.2",
     "raf-polyfill": "^1.0.0",

diff --git a/redirects-list.json b/redirects-list.json
@@ -5,7 +5,7 @@
   "^/doc/start/start-github(/.*)?$                                         /doc/start/github",
   "^/doc/start/start-gitlab(/.*)?$                                         /doc/start/gitlab",
 
-  "^/doc/install(/.*)?$                                                    /doc/install-with-npm 303",
+  "^/doc/install(/.*)?$                                                    /doc/start 303",
 
   "^/(.+)/$                                                                /$1"
 ]
diff --git a/yarn.lock b/yarn.lock
@@ -14969,7 +14969,7 @@ pretty-quick@^2.0.1:
     mri "^1.1.4"
     multimatch "^4.0.0"
 
-prismjs@^1.23.0:
+prismjs@^1.24.0:
   version "1.24.1"
   resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.24.1.tgz#c4d7895c4d6500289482fa8936d9cdd192684036"
   integrity sha512-mNPsedLuk90RVJioIky8ANZEwYm5w9LcvCXrxHlwf4fNVSn8jEipMybMkWUyyF0JhnC+C4VcOVSBuHRKs1L5Ow==
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- 'http://localhost:8000**'
		- 'http://localhost:9000**'