diff --git a/content/docs/install.md b/content/docs/install.md index daa28daf..7002a82e 100644 --- a/content/docs/install.md +++ b/content/docs/install.md @@ -1,30 +1,22 @@ # Installing CML as a Package -CML comes pre-installed in our provided -[Docker Images](/doc/self-hosted-runners#docker-images). Alternatively, GitHub -users can also use the [`setup-cml` action](/doc/start/github#setup-action). + -However, in all other cases, CML can be installed directly as a Node.js package -using the package manager `npm` ([see below](#installing-nodejs)): +Installing CML directly in CI environment is not typically needed, as comes +pre-installed in our provided [Docker Images]. Alternatively, GitHub users can +use the [`setup-cml` action]. -```cli -$ npm i -g @dvcorg/cml -``` +[docker images]: /doc/self-hosted-runners#docker-images +[`setup-cml` action]: /doc/start/github#setup-action -You may also need to install additional dependencies to use -[DVC plots](https://dvc.org/doc/command-reference/plots) and Vega-Lite: + -```cli -$ sudo apt-get install -y \ - libcairo2-dev libfontconfig-dev \ - libgif-dev libjpeg-dev libpango1.0-dev librsvg2-dev -$ npm install -g vega-cli vega-lite -``` +CML can be installed directly as a [Node.js](https://nodejs.org) package using +`npm`. -## Installing Node.js +
-Instructions for installing [Node.js](https://nodejs.org) and its package -manager `npm` can be found below. +### Installing Node.js @@ -51,3 +43,20 @@ install a particular version, add the following step to your workflow: + +
+ +```cli +$ npm i -g @dvcorg/cml +``` + +To use [DVC plots], you need to install these additional dependencies: + +```cli +$ sudo apt-get install -y \ + libcairo2-dev libfontconfig-dev \ + libgif-dev libjpeg-dev libpango1.0-dev librsvg2-dev +$ npm install -g vega-cli vega-lite +``` + +[dvc plots]: https://dvc.org/doc/command-reference/plots diff --git a/content/docs/sidebar.json b/content/docs/sidebar.json index 192371d4..7664e74a 100644 --- a/content/docs/sidebar.json +++ b/content/docs/sidebar.json @@ -33,6 +33,10 @@ "label": "Self-hosted Runners", "slug": "self-hosted-runners" }, + { + "label": "Install as a Package", + "slug": "install" + }, { "label": "Command Reference", "slug": "ref", @@ -68,10 +72,6 @@ } ] }, - { - "label": "Install as a Package", - "slug": "install" - }, { "label": "Contributing", "slug": "contributing", diff --git a/src/@dvcorg/gatsby-theme-iterative/components/LayoutHeader/index.tsx b/src/@dvcorg/gatsby-theme-iterative/components/LayoutHeader/index.tsx index 05a701c9..dbfcc3ae 100644 --- a/src/@dvcorg/gatsby-theme-iterative/components/LayoutHeader/index.tsx +++ b/src/@dvcorg/gatsby-theme-iterative/components/LayoutHeader/index.tsx @@ -1,6 +1,5 @@ import React from 'react' import { Flex, Box, Container, Button } from '@theme-ui/components' -import InstallPopup from '../../../../components/molecules/InstallPopup' import SmartLink from '../../../../components/atoms/SmartLink' import SiteLogo from '../../../../components/molecules/SiteLogo' import Alert from './Alert' @@ -145,7 +144,6 @@ const Header: React.FC = ({ isMain }) => { const collapsed = opened - const installPopup = usePopup() const otherToolsPopup = usePopup() return ( @@ -195,29 +193,6 @@ const Header: React.FC = ({ isMain }) => { {label} ))} - - - - -
  • - - Install - -
  • Support