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

[WIP] engine: move static/ contents into public/ and update links #879

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .restyled.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
restylers:
- name: prettier
image: restyled/restyler-prettier:v1.19.1
command: 'prettier'
arguments: '--write'
include: '{.,pages/**,src/**,public/**}/*.{js,jsx,md}'
interpreters: []
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
"test": "jest",
"start": "NODE_ENV=production node server.js",
"format-staged": "pretty-quick --staged --no-restage --bail",
"format-check": "prettier --check '{.,pages/**,src/**,static/**}/*.{js,jsx,md}'",
"format-check": "prettier --check '{.,pages/**,src/**,public/**}/*.{js,jsx,md}'",
"lint-check": "eslint src pages",
"format-all": "prettier --write '{.,pages/**,src/**,static/**}/*.{js,jsx,md}'",
"format-all": "prettier --write '{.,pages/**,src/**,public/**}/*.{js,jsx,md}'",
"format": "prettier --write"
},
"repository": {
Expand Down
10 changes: 5 additions & 5 deletions pages/_document.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,29 +61,29 @@ export default class Page extends Document {
<link
rel="shortcut icon"
type="image/x-icon"
href="/static/favicon.ico"
href="/favicon.ico"
/>
<link
rel="shortcut icon"
type="image/vnd.microsoft.icon"
href="/static/favicon.ico"
href="/favicon.ico"
/>
<link
rel="icon"
type="image/png"
href="/static/favicon-32x32.png"
href="/favicon-32x32.png"
sizes="32x32"
/>
<link
rel="icon"
type="image/png"
href="/static/favicon-16x16.png"
href="/favicon-16x16.png"
sizes="16x16"
/>
<link
rel="stylesheet"
type="text/css"
href="/static/fonts/fonts.css"
href="/fonts/fonts.css"
/>
<link
rel="stylesheet"
Expand Down
18 changes: 9 additions & 9 deletions pages/features.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export default function FeaturesPage() {
<Feature>
<Icon>
<img
src="/static/img/features/icons/git-icon.svg"
src="/img/features/icons/git-icon.svg"
alt="Git compatible"
/>
</Icon>
Expand All @@ -47,7 +47,7 @@ export default function FeaturesPage() {
<Feature>
<Icon>
<img
src="/static/img/features/icons/storage-icon.svg"
src="/img/features/icons/storage-icon.svg"
alt="Storage agnostic"
/>
</Icon>
Expand All @@ -62,7 +62,7 @@ export default function FeaturesPage() {
<Feature>
<Icon>
<img
src="/static/img/features/icons/repro.svg"
src="/img/features/icons/repro.svg"
alt="Reproducibility"
/>
</Icon>
Expand All @@ -77,7 +77,7 @@ export default function FeaturesPage() {
<Feature>
<Icon>
<img
src="/static/img/features/icons/branching.svg"
src="/img/features/icons/branching.svg"
alt="Low-friction branching"
/>
</Icon>
Expand All @@ -93,7 +93,7 @@ export default function FeaturesPage() {
</Feature>
<Feature>
<Icon>
<img src="/static/img/features/icons/storage-icon.svg" alt="" />
<img src="/img/features/icons/storage-icon.svg" alt="" />
</Icon>
<Name>Metric tracking</Name>
<Description>
Expand All @@ -105,7 +105,7 @@ export default function FeaturesPage() {
<Feature>
<Icon>
<img
src="/static/img/features/icons/ml-pipe.svg"
src="/img/features/icons/ml-pipe.svg"
alt="ML pipelines framework"
/>
</Icon>
Expand All @@ -120,7 +120,7 @@ export default function FeaturesPage() {
<Feature>
<Icon>
<img
src="/static/img/features/icons/languages-icon.svg"
src="/img/features/icons/languages-icon.svg"
alt="Language & framework agnostic"
/>
</Icon>
Expand All @@ -136,7 +136,7 @@ export default function FeaturesPage() {
<Feature>
<Icon>
<img
src="/static/img/features/icons/cluster.svg"
src="/img/features/icons/cluster.svg"
alt="HDFS, Hive & Apache Spark"
/>
</Icon>
Expand All @@ -152,7 +152,7 @@ export default function FeaturesPage() {
<Feature>
<Icon>
<img
src="/static/img/features/icons/failures.svg"
src="/img/features/icons/failures.svg"
alt="Failure tracking"
/>
</Icon>
Expand Down
10 changes: 5 additions & 5 deletions pages/support.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default function SupportPage() {
<Features>
<Feature>
<FeatureHeading>
<Icon url="/static/img/support/chat.svg" color="#945dd6" />
<Icon url="/img/support/chat.svg" color="#945dd6" />
<Name>Slack-like Chat</Name>
</FeatureHeading>
<Description>
Expand Down Expand Up @@ -67,7 +67,7 @@ export default function SupportPage() {
</Feature>
<Feature>
<FeatureHeading>
<Icon url="/static/img/support/bug.svg" color="#13adc7" />
<Icon url="/img/support/bug.svg" color="#13adc7" />
<Name>Bugs & Features</Name>
</FeatureHeading>
<Description>
Expand All @@ -86,7 +86,7 @@ export default function SupportPage() {
</Feature>
<Feature>
<FeatureHeading>
<Icon url="/static/img/support/forum.svg" color="#f46837" />
<Icon url="/img/support/forum.svg" color="#f46837" />
<Name>Forum</Name>
</FeatureHeading>
<Description>
Expand All @@ -102,7 +102,7 @@ export default function SupportPage() {
</Feature>
<Feature>
<FeatureHeading>
<Icon url="/static/img/support/email.svg" color="#945dd6" />
<Icon url="/img/support/email.svg" color="#945dd6" />
<Name>Email</Name>
</FeatureHeading>
<Description>
Expand Down Expand Up @@ -248,7 +248,7 @@ const DiscrodWidget = styled.img`
width: 50px;
height: 50px;
cursor: pointer;
mask-image: url('/static/img/support/discord.svg');
mask-image: url('/img/support/discord.svg');
mask-repeat: no-repeat;
mask-position: center;
background-color: #b88eeb;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ really excited to share the progress with you:
to use:

- More heavy operations render dynamic progress bar (e.g. hash computation):
![](/static/img/0.18-progress.gif)
![](/img/0.18-progress.gif)

- Pipeline visualization via command line. Just run `dvc pipeline show` with
`ascii` option and a target: ![](/static/img/0.18-pipeline.gif)
`ascii` option and a target: ![](/img/0.18-pipeline.gif)

- Many hidden gems: `dvc repro` dry and interactive modes, improved overall
commands verbosity and revised commands help.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ improvements) we have done in the last few months:
- 🙂 A lot of **UI improvements** . Starting from the finally fixed nasty issue
with Windows command prompt printing a lot of garbage symbols, to using
progress bars for checkouts, better metrics output, and lots of smaller
things: ![|528x200](/static/img/0.35-metrics.gif)
things: ![|528x200](/img/0.35-metrics.gif)

- **⚡️Performance optimizations.** The most notable one is the migration from
using the plain JSON file to the embedded SQLLite engine to cache file and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ predicting tags for a given StackOverflow question. For example, we might want a
classifier that can classify (or predict) posts about Python by tagging them
with `python`.

![](/static/img/example-flow-2x.png)
![](/img/example-flow-2x.png)

This is a natural language processing context, but NLP isn't the only area of
data science where DVC can help. DVC is designed to be agnostic of frameworks,
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ and reuse.

DVC has been built to address the reproducibility.

![](/static/img/reproducibility.png)
![](/img/reproducibility.png)

Git branches should beautifully reflect the non-linear structure common to the
ML process, where each hypothesis can be presented as a Git branch. However,
Expand All @@ -28,4 +28,4 @@ and this approach will not require storing binary files in your Git repository.
The diagram below describes all the DVC commands and relationships between a
local cache and remote storage.

![](/static/img/flow-large.png)
![](/img/flow-large.png)
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ StackOverflow posts and trains the prediction model and saves it as an
examples, tutorials, use cases if you want to cover other aspects of the DVC.
The pipeline itself is a sequence of transformation we apply to the data file:

![](/static/img/example-flow-2x.png)
![](/img/example-flow-2x.png)

DVC helps to describe these transformations and capture actual data involved -
input dataset we are processing, intermediate results (useful if some
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ datasets and ML models using DVC commands. We'll work with a
that [François Chollet](https://twitter.com/fchollet) put together to show how
to build a powerful image classifier using a pretty small dataset.

![](/static/img/cats-and-dogs.jpg) _Dataset to classify cats and dogs_
![](/img/cats-and-dogs.jpg) _Dataset to classify cats and dogs_

> We highly recommend reading the François' tutorial itself. It's a great
> demonstration of how a general pre-trained model can be leveraged to build a
Expand Down Expand Up @@ -252,7 +252,7 @@ to be similar to `git checkout`. All we need to do in our case is to
additionally run `dvc checkout` to get the right data into the
<abbr>workspace</abbr>.

![](/static/img/versioning.png)
![](/img/versioning.png)

There are two ways of doing this: a full workspace checkout or checkout of a
specific data or model file. Let's consider the full checkout first. It's pretty
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ with commands such as `dvc add`. With the aim to enable reusability of these
depend on data from an external <abbr>DVC project</abbr>, **similar to package
management systems, but for data science projects**.

![](/static/img/data-registry.png) _Data and models as code_
![](/img/data-registry.png) _Data and models as code_

Keeping this in mind, we could build a <abbr>DVC project</abbr> dedicated to
tracking and versioning _datasets_ (or any large data, even ML models). This way
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ storage on a server accessed by several users, in a way that enables almost
instantaneous <abbr>workspace</abbr> restoration/switching speed for everyone –
similar to `git checkout` for your code.

![](/static/img/shared-server.png)
![](/img/shared-server.png)

## Preparation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ supports Amazon S3, Microsoft Azure Blob Storage, Google Drive, Google Cloud
Storage, SSH, HDFS, and other remote locations. The list is constantly growing.
(For a complete list and configuration instructions, refer to `dvc remote add`.)

![](/static/img/model-sharing-digram.png)
![](/img/model-sharing-digram.png)

As an example, let's take a look at how you could setup an S3
[remote storage](/doc/command-reference/remote) for a <abbr>DVC project</abbr>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ for versioning. To actually store the data, DVC supports various types of
[remote storage](/doc/command-reference/remote). This allows easily saving and
sharing data alongside code.

![](/static/img/model-versioning-diagram.png)
![](/img/model-versioning-diagram.png)

In this basic scenario, DVC is a better replacement for `git-lfs` (see
[Related Technologies](/doc/understanding-dvc/related-technologies)) and for
Expand Down Expand Up @@ -111,7 +111,7 @@ If you run `git status` you will see that `data.dvc` is modified and currently
points to the version `v1.0` of the dataset. Meanwhile, code and model files are
their latest versions.

![](/static/img/versioning.png)
![](/img/versioning.png)

To share your data with others you need to setup a
[data storage](/doc/command-reference/remote). See the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ run the website.

To contribute documentation you need to know these locations:

- [Content](https://github.com/iterative/dvc.org/tree/master/static/docs)
(`/static/docs`):
- [Content](https://github.com/iterative/dvc.org/tree/master/docs)
(`/docs`):
[Markdown](https://guides.github.com/features/mastering-markdown/) files of
the different pages to render dynamically in the browser.
- [Images](https://github.com/iterative/dvc.org/tree/master/static/img)
(`/static/img`): Add new images, gif, svg, etc here. Reference them from the
Markdown files like this: `![](/static/img/reproducibility.png)`.
- [Sections](https://github.com/iterative/dvc.org/tree/master/static/docs/sidebar.json)
- [Images](https://github.com/iterative/dvc.org/tree/master/img)
(`/img`): Add new images, gif, svg, etc here. Reference them from the
Markdown files like this: `![](/img/reproducibility.png)`.
- [Sections](https://github.com/iterative/dvc.org/tree/master/docs/sidebar.json)
(`.../sidebar.json`): Edit it to register a new section for the navigation
menu.

Expand Down Expand Up @@ -134,4 +134,4 @@ pre-commit hook that is integrated when `yarn` installs the project dependencies

> Check out the `.md` source code of any command reference to get a better idea,
> for example in
> [this very file](https://raw.githubusercontent.com/iterative/dvc.org/master/static/docs/user-guide/contributing/docs.md).
> [this very file](https://raw.githubusercontent.com/iterative/dvc.org/master/docs/user-guide/contributing/docs.md).
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions static/fonts/fonts.css → public/fonts/fonts.css
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
@font-face {
font-family: BrandonGrotesque;
src: url('/static/fonts/Brandon_reg.otf');
src: url('/fonts/Brandon_reg.otf');
font-style: normal;
font-weight: normal;
}

@font-face {
font-family: BrandonGrotesqueBold;
src: url('/static/fonts/Brandon_bld.otf');
src: url('/fonts/Brandon_bld.otf');
font-style: normal;
font-weight: normal;
}

@font-face {
font-family: BrandonGrotesqueMed;
src: url('/static/fonts/Brandon_med.otf');
src: url('/fonts/Brandon_med.otf');
font-style: normal;
font-weight: normal;
}

@font-face {
font-family: BrandonGrotesqueLight;
src: url('/static/fonts/Brandon_light.otf');
src: url('/fonts/Brandon_light.otf');
font-style: normal;
font-weight: normal;
}
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading