Skip to content
This repository was archived by the owner on Apr 23, 2025. It is now read-only.

Commit 19b43d8

Browse files
committed
install: remove from menu, update in docs
moving nav entry before Cmd Ref and clarifying/simplifying the page as well
1 parent 4237192 commit 19b43d8

File tree

4 files changed

+32
-57
lines changed

4 files changed

+32
-57
lines changed

content/docs/install.md

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,22 @@
11
# Installing CML as a Package
22

3-
CML comes pre-installed in our provided
4-
[Docker Images](/doc/self-hosted-runners#docker-images). Alternatively, GitHub
5-
users can also use the [`setup-cml` action](/doc/start/github#setup-action).
3+
<admon>
64

7-
However, in all other cases, CML can be installed directly as a Node.js package
8-
using the package manager `npm` ([see below](#installing-nodejs)):
5+
Installing CML directly in CI environment is not typically needed, as comes
6+
pre-installed in our provided [Docker Images]. Alternatively, GitHub users can
7+
use the [`setup-cml` action].
98

10-
```cli
11-
$ npm i -g @dvcorg/cml
12-
```
9+
[docker images]: /doc/self-hosted-runners#docker-images
10+
[`setup-cml` action]: /doc/start/github#setup-action
1311

14-
You may also need to install additional dependencies to use
15-
[DVC plots](https://dvc.org/doc/command-reference/plots) and Vega-Lite:
12+
</admon>
1613

17-
```cli
18-
$ sudo apt-get install -y \
19-
libcairo2-dev libfontconfig-dev \
20-
libgif-dev libjpeg-dev libpango1.0-dev librsvg2-dev
21-
$ npm install -g vega-cli vega-lite
22-
```
14+
CML can be installed directly as a [Node.js](https://nodejs.org) package using
15+
`npm`.
2316

24-
## Installing Node.js
17+
<details>
2518

26-
Instructions for installing [Node.js](https://nodejs.org) and its package
27-
manager `npm` can be found below.
19+
### Installing Node.js
2820

2921
<toggle>
3022
<tab title="GitLab">
@@ -51,3 +43,20 @@ install a particular version, add the following step to your workflow:
5143
5244
</tab>
5345
</toggle>
46+
47+
</details>
48+
49+
```cli
50+
$ npm i -g @dvcorg/cml
51+
```
52+
53+
To use [DVC plots], you need to install these additional dependencies:
54+
55+
```cli
56+
$ sudo apt-get install -y \
57+
libcairo2-dev libfontconfig-dev \
58+
libgif-dev libjpeg-dev libpango1.0-dev librsvg2-dev
59+
$ npm install -g vega-cli vega-lite
60+
```
61+
62+
[dvc plots]: https://dvc.org/doc/command-reference/plots

content/docs/sidebar.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@
3333
"label": "Self-hosted Runners",
3434
"slug": "self-hosted-runners"
3535
},
36+
{
37+
"label": "Install as a Package",
38+
"slug": "install"
39+
},
3640
{
3741
"label": "Command Reference",
3842
"slug": "ref",
@@ -68,10 +72,6 @@
6872
}
6973
]
7074
},
71-
{
72-
"label": "Install as a Package",
73-
"slug": "install"
74-
},
7575
{
7676
"label": "Contributing",
7777
"slug": "contributing",

src/components/molecules/HamburgerMenu/index.tsx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,6 @@ export const HamburgerMenu: React.FC<
9494
Doc
9595
</Link>
9696
</li>
97-
<li className={styles.section}>
98-
<Link
99-
href="/doc/install"
100-
className={styles.sectionHeading}
101-
onClick={handleItemClick('install')}
102-
>
103-
Install
104-
</Link>
105-
</li>
10697

10798
<li className={styles.section}>
10899
<div className={styles.sectionHeading}>Support</div>

src/components/organisms/SiteHeader/index.tsx

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import React from 'react'
22
import { Flex, Box, Container, Button } from '@theme-ui/components'
3-
import InstallPopup from '../../molecules/InstallPopup'
43
import SmartLink from '../../atoms/SmartLink'
54
import SiteLogo from '../../molecules/SiteLogo'
65
import Alert from './Alert'
@@ -145,7 +144,6 @@ const Header: React.FC<IHeaderProps> = ({ isMain }) => {
145144

146145
const collapsed = opened
147146

148-
const installPopup = usePopup()
149147
const otherToolsPopup = usePopup()
150148

151149
return (
@@ -193,29 +191,6 @@ const Header: React.FC<IHeaderProps> = ({ isMain }) => {
193191
{label}
194192
</SmartLink>
195193
))}
196-
<Box
197-
ref={installPopup?.containerEl}
198-
sx={{ position: ['static', 'relative'] }}
199-
onMouseEnter={installPopup.open}
200-
onMouseLeave={installPopup.close}
201-
>
202-
<Button
203-
onPointerUp={installPopup.toggle}
204-
onKeyUp={onSelectKey(installPopup.toggle)}
205-
variant="layout.Header.Nav.NavButton"
206-
sx={
207-
installPopup.isOpen
208-
? { variant: 'layout.Header.Nav.NavButton.Active' }
209-
: {}
210-
}
211-
>
212-
Install
213-
</Button>
214-
<InstallPopup
215-
onClose={installPopup.close}
216-
isOpen={installPopup.isOpen}
217-
/>
218-
</Box>
219194
<Box
220195
variant="layout.Header.Nav.OtherTools"
221196
ref={otherToolsPopup.containerEl}

0 commit comments

Comments
 (0)