Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Docs Site Content Migration #358

Draft
wants to merge 50 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
fd3e9c9
first pass at docs content migration and integaration with docsy WIP
exactlyallan Dec 2, 2023
d89fafd
Merge remote-tracking branch 'allan/docs-migration' into docs-migration
ajschmidt8 Jan 5, 2024
7bb2dc9
rm `target=_blank` from navbar links
ajschmidt8 Jan 5, 2024
ebcff18
fix more header/footer links
ajschmidt8 Jan 5, 2024
564c238
update placeholder text
ajschmidt8 Jan 5, 2024
46057f5
make `notices/` drafts
ajschmidt8 Jan 5, 2024
2bec059
scope `a` `font-weight` style to landing pages
ajschmidt8 Jan 5, 2024
28a9a13
fix `GitHub Actions` page title
ajschmidt8 Jan 5, 2024
cea854d
rm `Intended Audience` sections
ajschmidt8 Jan 5, 2024
70cbd2c
fix nav font-weight
ajschmidt8 Jan 5, 2024
17ddc0b
replace Jekyll `link` w/ Hugo `relref`
ajschmidt8 Jan 5, 2024
2b0e06a
scope `pre` styles to landing pages
ajschmidt8 Jan 5, 2024
c52cf05
enable git/github info
ajschmidt8 Jan 5, 2024
89c5f65
set `notices` type to `blog`
ajschmidt8 Jan 5, 2024
74c1084
add temporary partial for source code issue
ajschmidt8 Jan 6, 2024
081a47b
add `rsn0036.md`
ajschmidt8 Jan 6, 2024
ae13dd5
rm carriage returns from notices
ajschmidt8 Jan 6, 2024
ced8758
add `date` frontmatter for notices
ajschmidt8 Jan 6, 2024
1fc89ea
Merge remote-tracking branch 'upstream/main' into docs-migration
ajschmidt8 Mar 12, 2024
76a8809
add `render-link.html` to open external links in new tab
ajschmidt8 Mar 12, 2024
9dcdf75
fix some links
ajschmidt8 Mar 12, 2024
f0a761a
rm `target="_blank"`
ajschmidt8 Mar 12, 2024
eccb569
rm unsupported `{: ... }` syntax
ajschmidt8 Mar 12, 2024
f4b2ae8
bring `docs/install` up-to-date
ajschmidt8 Mar 13, 2024
728770c
render HTML in markdown files
ajschmidt8 Mar 13, 2024
4bf78d9
add `data/{,previous_}releases.json`
ajschmidt8 Mar 13, 2024
25d59c4
add selector
ajschmidt8 Mar 13, 2024
caddf77
add `rapids_version` shortcode
ajschmidt8 Mar 13, 2024
3ea6fdf
update user guides page
ajschmidt8 Mar 13, 2024
780d313
fix slack URL
ajschmidt8 Mar 13, 2024
5ff8e57
fix selector copy btn colors
ajschmidt8 Mar 13, 2024
4e7c620
replace `{,previous_}releases.json` w/ `releases.yaml`
ajschmidt8 Mar 13, 2024
16234f6
update/add `rapids_version` shortcode/partial
ajschmidt8 Mar 13, 2024
75ce0c2
consolidate releases into new layout
ajschmidt8 Mar 13, 2024
362b419
use `rapids_version` shortcode where necessary
ajschmidt8 Mar 13, 2024
65551fd
add language specifiers to code fences
ajschmidt8 Mar 13, 2024
5e4adb4
rm `depmgmt.md`
ajschmidt8 Mar 13, 2024
d99c933
switch devcontainer to `docker-compose`
ajschmidt8 Mar 15, 2024
7e40a62
add initial vercel files
ajschmidt8 Mar 15, 2024
b13c0d0
add vercel scripts, `libraries.yaml`, draft API layout
ajschmidt8 Mar 16, 2024
fae2ec6
ensure devcontainer works for arm64 and amd64
ajschmidt8 Jun 14, 2024
1921805
Merge remote-tracking branch 'upstream/main' into docs-migration
ajschmidt8 Sep 19, 2024
7deb626
add `TODO` for future `docker-compose.yaml` services
ajschmidt8 Sep 19, 2024
2130742
rm `draft: true` from `docs`, `notices`, and `user-guides`
ajschmidt8 Sep 19, 2024
dddf279
Merge branch 'main' into docs-migration
ajschmidt8 Sep 19, 2024
ecaf45c
Merge remote-tracking branch 'upstream/main' into docs-migration
ajschmidt8 Sep 19, 2024
32a0b34
Merge branch 'main' into docs-migration
ajschmidt8 Sep 20, 2024
419b2f9
rm duplicate tool installations
ajschmidt8 Sep 26, 2024
5d886ee
rm empty `proxy.Dockerfile`
ajschmidt8 Sep 26, 2024
3e2fb88
create a `/releases.json` file
ajschmidt8 Sep 26, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .devcontainer/devcontainer.Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
FROM mcr.microsoft.com/devcontainers/base:bookworm

USER vscode

# Install Go
ENV GOTOOLCHAIN=local
ENV GOPATH /home/vscode/go
ENV PATH $GOPATH/bin:/home/vscode/.local/go/bin:$PATH
COPY --from=golang:bookworm --chown=vscode:vscode /usr/local/go /home/vscode/.local
RUN mkdir -p "$GOPATH/src" "$GOPATH/bin"

# Install nvm
RUN <<EOF
export PROFILE=/dev/null
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
cat <<EOS | tee --append /home/vscode/.bashrc /home/vscode/.zshrc
export NVM_DIR="\$HOME/.nvm"
[ -s "\$NVM_DIR/nvm.sh" ] && \. "\$NVM_DIR/nvm.sh" # This loads nvm
[ -s "\$NVM_DIR/bash_completion" ] && \. "\$NVM_DIR/bash_completion" # This loads nvm bash_completion
EOS
EOF

# Install yq
COPY --from=mikefarah/yq /usr/bin/yq /home/vscode/.local/bin/yq

# Install jq, Python
ENV VIRTUAL_ENV="/home/vscode/venv"
RUN <<EOF
sudo apt-get update
export DEBIAN_FRONTEND=noninteractive
sudo apt-get -y install --no-install-recommends \
jq \
python3 python3-pip python3-venv
sudo apt-get clean
sudo rm -rf /var/lib/apt/lists/*

python3 -m venv "${VIRTUAL_ENV}"
EOF
ENV PATH="$VIRTUAL_ENV/bin:$PATH"
29 changes: 7 additions & 22 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,23 +1,8 @@
{
"name": "rapids-site",
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"forwardPorts": [
1313
],
"features": {
"ghcr.io/devcontainers/features/go:1": {},
"ghcr.io/devcontainers/features/node:1": {
"version": "none",
"nodeGypDependencies": false
},
"ghcr.io/eitsupi/devcontainer-features/jq-likes:2": {
"jqVersion": "latest",
"yqVersion": "latest"
},
"ghcr.io/devcontainers/features/python:1": {
"version": "latest",
"installTools": false
}
},
"postCreateCommand": "./scripts/devcontainer-init.sh"
}
"name": "rapids-site",
"dockerComposeFile": "docker-compose.yaml",
"service": "devcontainer",
"workspaceFolder": "/workspace/rapids.ai",
"forwardPorts": [1313],
"postCreateCommand": "./scripts/devcontainer-init.sh"
}
13 changes: 13 additions & 0 deletions .devcontainer/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: '3.3'

services:
devcontainer:
build:
context: .
dockerfile: devcontainer.Dockerfile
volumes:
- ..:/workspace/rapids.ai
command: /bin/sh -c "while sleep 1000; do :; done"
# TODO: add a reverse proxy & Hugo container. The reverse proxy container should
# parse the redirects in the output of `scripts/vercel/config.mjs` to ensure
# local development behaves like preview environments on PRs.
1 change: 1 addition & 0 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
@import "rapidsai/post";
@import "rapidsai/slant";
@import "rapidsai/tags";
@import "rapidsai/selector";
31 changes: 17 additions & 14 deletions assets/scss/rapidsai/__general.scss
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,23 @@ body {
margin: 0;
padding: 0;
}

a {
font-weight: 700;
}

pre {
position: relative;
background-color: #efefef;
padding: 1em;
border-top: 2px solid #dedede;
word-break: break-word;
white-space: pre-wrap;
margin-right: 1rem;
overflow: visible;
box-shadow: 0px 3px 2px rgba(0, 0, 0, 0.2);
color: #4a4a4a
}
}

img {
Expand All @@ -57,7 +74,6 @@ img {
a {
color: #37c9dd;
cursor: pointer;
font-weight: 700;
transition: all 0.4s ease-out;
}

Expand Down Expand Up @@ -120,19 +136,6 @@ strong {
color: inherit;
}

pre {
position: relative;
background-color: #efefef;
padding: 1em;
border-top: 2px solid #dedede;
word-break: break-word;
white-space: pre-wrap;
margin-right: 1rem;
overflow: visible;
box-shadow: 0px 3px 2px rgba(0, 0, 0, 0.2);
color: #4a4a4a
}

code {
color: #151515;
background-color: #efefef;
Expand Down
1 change: 1 addition & 0 deletions assets/scss/rapidsai/_navigation.scss
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
.navigation__item {
color: white;
position: relative;
font-weight: 700;

@include media-breakpoint-up(lg) {
display: flex;
Expand Down
138 changes: 138 additions & 0 deletions assets/scss/rapidsai/_selector.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
.selector {
background-color: #9943ff;
padding: 1rem;
border-radius: 5px;
}

.selector__options-container {
display: flex;
flex-direction: row;
flex-wrap: nowrap;
}

.selector__options-container--narrow {
width: 97%;
margin: 0 auto;
}

.selector__option-label,
.selector__cmd-label {
color: white;
width: 6em;
text-transform: uppercase;
font-weight: 600;
margin-top: 0.6em;
margin-right: 0.6em;
text-align: right;
}

.selector__option {
background: #e3e3e3;
color: #3c3c3c;
flex: 1 1;
margin: 0.2em;
padding: 0.3em;
cursor: pointer;
line-height: 1.5em;
box-shadow: 2px 2px 2px rgba(10, 10, 10, 0.4);
border-radius: 2px;
}

.selector__option.active {
background: #36c9dd;
font-weight: 600;
color: #424242;
}

.selector__option.disabled {
background: #a785e7 !important;
color: #706880;
cursor: not-allowed;
user-select: none;
}

.selector__option:hover,
.selector__option.active:hover,
.selector__copy-btn:hover {
background: #ffb500;
box-shadow: 1px 1px 0px rgba(10, 10, 10, 0.7);
transition: background-color 0.3s ease-in-out;
transition: box-shadow 0.1s ease-in-out;
color: var(--bs-gray-900);
}

.selector__note code {
background: #e3e3e3;
color: #000000;
padding: 0.08em 0.15em;
border-radius: 4px;
}

.selector__note-container {
color: white;
flex: 1 1;
margin: 0.2em;
padding: 0.3em;
line-height: 1.5em;
padding: 0 1em;
text-align: center;
}

.selector__note {
margin-top: 0.5rem;
margin-bottom: 0.5rem;
}

.selector__cmd-container {
display: flex;
margin-top: 2rem;
}

.selector__cmd-bg {
cursor: text;
overflow: auto;
width: calc(100% - 6em);
border-radius: 4px;
}

.selector__copy-btn {
background: #e3e3e3;
border-radius: 0.3rem;
color: var(--bs-gray-900);
flex: 1 1;
margin: 0.5em;
padding: 0.6em;
cursor: pointer;
line-height: 1.5em;
box-shadow: 2px 2px 2px rgba(10, 10, 10, 0.4);
}

.selector__copy-container {
text-align: center;
margin-top: 1em;
}

.selector__copy-btn {
margin: 0 1em;
}

.selector__cmd {
padding: 0.75rem;
margin: 0;
-webkit-overflow-scrolling: touch;
background-color: #f5f6fa;
}

.selector__cmd code {
padding: 0;
border: 0;
}

.selector__cmd .nb {
color: #920b60;
}

.selector__cmd .nt,
.selector__cmd .nv {
color: #268bd2;
}
15 changes: 5 additions & 10 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
---
title: Documentation
linkTitle: RAPIDS Documentation
description: Gateway to the RAPIDS documentation content
weight: 1
cascade:
body_class: mt-8 mt-md-0 # accounts for fixed header
draft: true
---

Some introductory text below the H1 title. Welcome to RAPIDS. Here is our documentation. More words go here. Let's make the demo text a little longer.

## Overview
This is a docs page!

Yes, it doesn't look great at the moment. We'll need to continue to refactor some styles from the Bulma -> Bootstrap migration.
We'll need to continue to refactor things.

That won't take long.

When it's done, our documentation pages on rapids.ai will look like this: https://www.docsy.dev/docs/.

Things to fix (non-exhaustive list):

- Element spacing
- Navbar offset (or potentially keeping the navbar statically placed on doc pages)
When it's done, the documentation pages on rapids.ai will look like this: https://www.docsy.dev/docs/.

Here's what a list looks like:

Expand Down
17 changes: 0 additions & 17 deletions content/docs/api-docs.md

This file was deleted.

31 changes: 31 additions & 0 deletions content/docs/api/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: API Docs
linkTitle: API Documentation
description: Gateway to the RAPIDS documentation content
layout: api
type: docs
weight: 1
---

Access our current docs for the RAPIDS projects below. Docs are available in
both "stable" and "nightly" versions. The description of each is below to help
select the docs that fit your needs.

<dl>
<dt>STABLE</dt>
<dd>Current release docs; considered to be stable.</dd>
<dt>NIGHTLY</dt>
<dd>Work-in-progress release docs; considered to be unstable and released nightly.</dd>
<dt>LEGACY</dt>
<dd>Previous release docs; available for reference.</dd>
</dl>

<hr>

## CHECK IT OUT!!!

This is a demo of the proxied documentation for each library.

Current `legacy`, `stable`, `nightly` docs are all available through convenient URLs (e.g. [/docs/cudf/legacy/](/docs/cudf/legacy/)).

Any old documentation versions in our S3 bucket are also available via permanent versioned links (e.g. [/docs/cudf/23.02/](/docs/cudf/23.02/)).
15 changes: 0 additions & 15 deletions content/docs/build-test-automation/_index.md

This file was deleted.

Loading