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.

Sign up for GitHub

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

Allowed title as props for <details> #3388

Closed
wants to merge 2 commits into from
Closed

Allowed title as props for <details> #3388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d7cdc3
allowed details title as props as well
yathomasi Mar 24, 2022
44091ce
Merge branch 'master' into details-title-as-props
jorgeorpinel Mar 29, 2022
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
4 changes: 1 addition & 3 deletions content/docs/command-reference/checkout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,7 @@ pipeline stages, such as the <abbr>DVC project</abbr> created for the
[Get Started](/doc/start). Then we can see what happens with `git checkout` and
`dvc checkout` as we switch from tag to tag.

<details>

### Click and expand to set up the project
<details title="Click and expand to set up the project>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this PR update all existing <details> blocks? Thanks


Start by cloning our example repo if you don't already have it:

Expand Down
4 changes: 1 addition & 3 deletions content/docs/command-reference/commit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,7 @@ pipeline stages, such as the <abbr>DVC project</abbr> created for the
[Get Started](/doc/start). Then we can see what happens with `git commit` and
`dvc commit` in different situations.

<details>

### Click and expand to set up the project
<details title="Click and expand to set up the project">

Start by cloning our example repo if you don't already have it:

Expand Down
16 changes: 4 additions & 12 deletions content/docs/command-reference/diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,7 @@ for example when `dvc init` was used with the `--no-scm` option.

For these examples we can use the [Get Started](/doc/start) project.

<details>

### Click and expand to set up the project to run examples
<details title="Click and expand to set up the project to run examples">

Start by cloning our example repo if you don't already have it:

Expand Down Expand Up @@ -119,9 +117,7 @@ $ dvc diff

## Example: Comparing workspace with arbitrary commits

<details>

### Click and expand to set up the example
<details title="Click and expand to set up the example">

Let's checkout the
[2-track-data](https://github.com/iterative/example-get-started/releases/tag/2-track-data)
Expand Down Expand Up @@ -149,9 +145,7 @@ files summary: 1 added, 0 deleted, 0 modified

## Example: Comparing tags or branches

<details>

### Click and expand to set up the example
<details title="Click and expand to set up the example">

Our example repository has the `baseline-experiment` and `bigrams-experiment`
[tags](https://github.com/iterative/example-get-started/tags) tags, that
Expand Down Expand Up @@ -223,9 +217,7 @@ It outputs:

## Example: Renamed files

<details>

### Click and expand to set up the example
<details title="Click and expand to set up the example">

Having followed the previous examples' setup, move into the
`example-get-started/` directory. Then make sure that you have the latest code
Expand Down
4 changes: 1 addition & 3 deletions content/docs/command-reference/exp/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,7 @@ committing them to the Git repo. Unnecessary ones can be [cleared] with
> This is based on our [Get Started](/doc/start/experiments), where you can find
> the actual source code.

<details>

### Expand to prepare the example ML project
<details title="Expand to prepare the example ML project">

Clone the DVC repo and download the data it <abbr>depends</abbr> on:

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/fetch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ pipeline stages, such as the <abbr>DVC project</abbr> created for the
[Get Started](/doc/start). Then we can see what `dvc fetch` does in different
scenarios.

<details>
<details title="Click and expand to set up the example">

### Click and expand to set up the project
Comment on lines -120 to 122
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing header remaining here makes breaks this block
image


Expand Down
28 changes: 7 additions & 21 deletions content/docs/command-reference/get-url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,7 @@ $ wget https://example.com/path/to/data.csv

## Examples

<details>

### Amazon S3
<details title="Amazon S3">

This command will copy an S3 object into the current working directory with the
same file name:
Expand All @@ -106,9 +104,7 @@ configuration, you can use the parameters described in `dvc remote modify`.

</details>

<details>

### Google Cloud Storage
<details title="Google Cloud Storage">

```dvc
$ dvc get-url gs://bucket/path file
Expand All @@ -118,9 +114,7 @@ The above command downloads the `/path` file (or directory) into `./file`.

</details>

<details>

### SSH
<details title="SSH">

```dvc
$ dvc get-url ssh://[email protected]/path/to/data
Expand All @@ -131,19 +125,15 @@ directory).

</details>

<details>

### HDFS
<details title="HDFS">

```dvc
$ dvc get-url hdfs://[email protected]/path/to/file
```

</details>

<details>

### HTTP
<details title="HTTP">

> Both HTTP and HTTPS protocols are supported.

Expand All @@ -153,19 +143,15 @@ $ dvc get-url https://example.com/path/to/file

</details>

<details>

### WebHDFS
<details title="WebHDFS">

```dvc
$ dvc get-url webhdfs://[email protected]/path/to/file
```

</details>

<details>

### local
<details title="Local file system paths">

```dvc
$ dvc get-url /local/path/to/data
Expand Down
8 changes: 2 additions & 6 deletions content/docs/command-reference/import-url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,7 @@ produces a regular stage in `dvc.yaml`.
To illustrate these examples we will be using the <abbr>project</abbr> explained
in the [Get Started](/doc/start).

<details>

### Click and expand to set up example
<details title="Click and expand to set up example">
Comment on lines -173 to +171
Copy link
Contributor

@jorgeorpinel jorgeorpinel Mar 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK just noticed we're postponing this. Just a note that per #3391 these titles should no longer start in "Click for" nor end in "example" (same throughout docs codebase). Thanks


Start by cloning our example repo if you don't already have it. Then move into
the repo and checkout the
Expand Down Expand Up @@ -285,9 +283,7 @@ $ unzip code.zip
$ rm -f code.zip
```

<details>

### Click and expand to set up the environment
<details title="Click and expand to set up the environment">

Let's install the requirements. But before we do that, we **strongly** recommend
creating a
Expand Down
4 changes: 1 addition & 3 deletions content/docs/command-reference/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,7 @@ pipeline stages, such as the <abbr>DVC project</abbr> created in our
[Get Started](/doc/start) section. Then we can see what happens with
`dvc install` in different situations.

<details>

### Click and expand to set up the project
<details title="Click and expand to set up the project">

Start by cloning our example repo if you don't already have it:

Expand Down
8 changes: 2 additions & 6 deletions content/docs/command-reference/plots/show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,7 @@ We'll use tabular metrics file `train.json` for this example:
}
```

<details>

### Expand for YAML format
<details title="Expand to prepare the example ML project">

Here's a corresponding `train.yaml` metrics file:

Expand Down Expand Up @@ -154,9 +152,7 @@ epoch,accuracy,loss,val_accuracy,val_loss
7,0.9954,0.01396906608727198,0.9802,0.07247738889862157
```

<details>

### Expand for TSV format
<details title="Expand for TSV format">

Here's a corresponding `train.tsv` metrics file:

Expand Down
4 changes: 1 addition & 3 deletions content/docs/command-reference/pull.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,7 @@ Let's employ a simple <abbr>workspace</abbr> with some data, code, ML models,
pipeline stages, such as the <abbr>DVC project</abbr> created for the
[Get Started](/doc/start). Then we can see what happens with `dvc pull`.

<details>

### Click and expand to set up the project
<details title="Click and expand to set up the project">

Start by cloning our example repo if you don't already have it:

Expand Down
48 changes: 12 additions & 36 deletions content/docs/command-reference/remote/add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,7 @@ DVC will determine the [type of remote](#supported-storage-types) based on the

The following are the types of remote storage (protocols) supported:

<details>

### Amazon S3
<details title="Amazon S3">

> 💡 Before adding an S3 remote, be sure to
> [Create a Bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html).
Expand All @@ -113,9 +111,7 @@ methods that are performed by DVC (`list_objects_v2` or `list_objects`,

</details>

<details>

### S3-compatible storage
<details title="S3-compatible storage">

For object storage that supports an S3-compatible API (e.g.
[Minio](https://min.io/),
Expand All @@ -141,9 +137,7 @@ they're effective depends on each storage platform.

</details>

<details>

### Microsoft Azure Blob Storage
<details title="Microsoft Azure Blob Storage">

```dvc
$ dvc remote add -d myremote azure://mycontainer/path
Expand All @@ -163,9 +157,7 @@ To use a custom authentication method, use the parameters described in

</details>

<details>

### Google Drive
<details title="Google Drive">

To start using a GDrive remote, first add it with a
[valid URL format](/doc/user-guide/setup-google-drive-remote#url-format). Then
Expand Down Expand Up @@ -197,9 +189,7 @@ modified.

</details>

<details>

### Google Cloud Storage
<details title="Google Cloud Storage">

> 💡 Before adding a GC Storage remote, be sure to
> [Create a storage bucket](https://cloud.google.com/storage/docs/creating-buckets).
Expand All @@ -219,9 +209,7 @@ parameters, use the parameters described in `dvc remote modify`.

</details>

<details>

### Aliyun OSS
<details title="Aliyun OSS">

First you need to set up OSS storage on Aliyun Cloud. Then, use an S3 style URL
for OSS storage, and configure the
Expand Down Expand Up @@ -261,9 +249,7 @@ $ export OSS_ACCESS_KEY_SECRET='mysecret'

</details>

<details>

### SSH
<details title="SSH">

```dvc
$ dvc remote add -d myremote ssh://[email protected]/path
Expand All @@ -279,9 +265,7 @@ Please check that you are able to connect both ways with tools like `ssh` and

</details>

<details>

### HDFS
<details title="HDFS">

⚠️ Using HDFS with a Hadoop cluster might require additional setup. Our
assumption is that the client is set up to use it. Specifically, [`libhdfs`]
Expand All @@ -301,9 +285,7 @@ $ dvc remote add -d myremote hdfs://[email protected]/path

</details>

<details>

### WebHDFS
<details title="WebHDFS">

⚠️ Using WebHDFS requires to enable REST API access in the cluster: set the
config property `dfs.webhdfs.enabled` to `true` in `hdfs-site.xml`.
Expand All @@ -329,9 +311,7 @@ active kerberos session.

</details>

<details>

### HTTP
<details title="HTTP">

```dvc
$ dvc remote add -d myremote https://example.com/path
Expand All @@ -341,9 +321,7 @@ $ dvc remote add -d myremote https://example.com/path

</details>

<details>

### WebDAV
<details title="WebDAV">

```dvc
$ dvc remote add -d myremote \
Expand All @@ -362,9 +340,7 @@ $ dvc remote add -d myremote \

</details>

<details>

### local remote
<details title="Local file system paths">

A "local remote" is a directory in the machine's file system. Not to be confused
with the `--local` option of `dvc remote` (and other config) commands!
Expand Down
4 changes: 1 addition & 3 deletions content/docs/command-reference/remote/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,7 @@ manually.

## Example: Add a default local remote

<details>

### What is a "local remote" ?
<details title=' What is a "local remote" ?'>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While it looks alright since the result is trimmed, we should trim out the excess spaces here.


While the term may seem contradictory, it doesn't have to be. The "local" part
refers to the type of location where the storage is: another directory in the
Expand Down
4 changes: 1 addition & 3 deletions content/docs/command-reference/remote/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ local config files (in that order).

For simplicity, let's add a default local remote:

<details>

### What is a "local remote" ?
<details title='What is a "local remote" ?'>

While the term may seem contradictory, it doesn't have to be. The "local" part
refers to the type of location where the storage is: another directory in the
Expand Down
Loading