Skip to content

Commit d762a66

Browse files
authored
moving these to their proper location (#87)
* moving docs and update links to new location * re-order the pages in mkdocs file
1 parent ab04186 commit d762a66

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

docs/getting_started/basic/install.md renamed to docs/fiftyone_concepts/install.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Note
44

55
Need to collaborate on your datasets? Check out
6-
[FiftyOne Teams](../../teams/index.md#fiftyone-teams)!
6+
[FiftyOne Teams](../teams/index.md#fiftyone-teams)!
77

88
## Prerequisites [](\#prerequisites "Permalink to this headline")
99

@@ -50,8 +50,8 @@ If you want to work with video datasets, you’ll also need to install
5050
## Quickstart [](\#quickstart "Permalink to this headline")
5151

5252
Dive right into FiftyOne by opening a Python shell and running the snippet
53-
below, which downloads a [small dataset](../../data/dataset_zoo/datasets.md#dataset-zoo-quickstart) and
54-
launches the [FiftyOne App](../../fiftyone_concepts/app.md#fiftyone-app) so you can explore it!
53+
below, which downloads a [small dataset](../data/dataset_zoo/datasets.md#dataset-zoo-quickstart) and
54+
launches the [FiftyOne App](app.md#fiftyone-app) so you can explore it!
5555

5656
```python
5757
import fiftyone as fo
@@ -64,7 +64,7 @@ session = fo.launch_app(dataset)
6464

6565
Note that if you are running this code in a script, you must include
6666
[`session.wait()`](../../api/fiftyone.core.session.html#fiftyone.core.session.Session.wait "fiftyone.core.session.Session.wait") to block execution
67-
until you close the App. See [this page](../../fiftyone_concepts/app.md#creating-an-app-session) for
67+
until you close the App. See [this page](app.md#creating-an-app-session) for
6868
more information.
6969

7070
## Troubleshooting [](\#troubleshooting "Permalink to this headline")
@@ -165,8 +165,8 @@ a dataset for the first time in a newer version of FiftyOne.
165165
Note
166166

167167
If you are working with a
168-
[custom/shared MongoDB database](../../fiftyone_concepts/config.md#configuring-mongodb-connection), you
169-
can use [database admin privileges](../../fiftyone_concepts/config.md#database-migrations) to control
168+
[custom/shared MongoDB database](config.md#configuring-mongodb-connection), you
169+
can use [database admin privileges](config.md#database-migrations) to control
170170
which clients are allowed to upgrade your FiftyOne deployment.
171171

172172
## Downgrading FiftyOne [](\#downgrading-fiftyone "Permalink to this headline")
@@ -175,7 +175,7 @@ If you need to downgrade to an older version of FiftyOne for any reason, you
175175
can do so.
176176

177177
Since new releases occasionally introduce backwards-incompatible changes to the
178-
data model, you must use the [fiftyone migrate](../../cli/index.md#cli-fiftyone-migrate)
178+
data model, you must use the [fiftyone migrate](../cli/index.md#cli-fiftyone-migrate)
179179
command to perform any necessary downward database migrations
180180
**before installing the older version of FiftyOne**.
181181

@@ -198,7 +198,7 @@ fiftyone migrate --info
198198

199199
If you are reading this after encountering an error resulting from downgrading
200200
your `fiftyone` package without first running
201-
[fiftyone migrate](../../cli/index.md#cli-fiftyone-migrate), don’t worry, you simply need to
201+
[fiftyone migrate](../cli/index.md#cli-fiftyone-migrate), don’t worry, you simply need to
202202
reinstall the newer version of FiftyOne and then follow these instructions.
203203

204204
See [this page](troubleshooting.md#troubleshooting-downgrades) if you need to install
@@ -207,8 +207,8 @@ FiftyOne v0.7.3 or earlier.
207207
Note
208208

209209
If you are working with a
210-
[custom/shared MongoDB database](../../fiftyone_concepts/config.md#configuring-mongodb-connection), you
211-
can use [database admin privileges](../../fiftyone_concepts/config.md#database-migrations) to control
210+
[custom/shared MongoDB database](config.md#configuring-mongodb-connection), you
211+
can use [database admin privileges](config.md#database-migrations) to control
212212
which clients are allowed to downgrade your FiftyOne deployment.
213213

214214
## Uninstalling FiftyOne [](\#uninstalling-fiftyone "Permalink to this headline")

docs/getting_started/basic/troubleshooting.md renamed to docs/fiftyone_concepts/troubleshooting.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,14 @@ pip install ipython
122122

123123
FiftyOne includes a `fiftyone-db` package wheel for your operating system and
124124
hardware. If you have not
125-
[configured your own database connection](../../fiftyone_concepts/config.md#configuring-mongodb-connection),
125+
[configured your own database connection](config.md#configuring-mongodb-connection),
126126
then FiftyOne’s database service will attempt to start up on import using the
127127
MongoDB distribution provided by `fiftyone-db`. If the database fails to start,
128128
importing `fiftyone` will result in exceptions being raised.
129129

130130
## Downgrading to old versions [¶](\#downgrading-to-old-versions "Permalink to this headline")
131131

132-
The [fiftyone migrate](../../cli/index.md#cli-fiftyone-migrate) command was introduced in
132+
The [fiftyone migrate](../cli/index.md#cli-fiftyone-migrate) command was introduced in
133133
FiftyOne v0.7.3. If you would like to downgrade from a FiftyOne version
134134
prior to v0.7.3 (to a yet older version), then you will first need to
135135
[upgrade](install.md#upgrading-fiftyone) to v0.7.3 or later and then
@@ -185,7 +185,7 @@ sudo apt install libssl-dev
185185
```
186186

187187
If you still face issues with imports, you can follow
188-
[these instructions](../../fiftyone_concepts/config.md#configuring-mongodb-connection) to configure
188+
[these instructions](config.md#configuring-mongodb-connection) to configure
189189
FiftyOne to use a MongoDB instance that you have installed yourself.
190190

191191
### Troubleshooting Windows imports [¶](\#troubleshooting-windows-imports "Permalink to this headline")

mkdocs.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,6 @@ nav:
6262
- Installing: getting_started/basic/install.md
6363
- Basics:
6464
- getting_started/basic/index.md
65-
- Installing: getting_started/basic/install.md
66-
- Virtualenvs: getting_started/basic/virtualenv.md
6765
- Datasets, Samples, and Fields: getting_started/basic/datasets_samples_fields.md
6866
- Tour of the Application: getting_started/basic/application_tour.md
6967
- Visualizing Embeddings: getting_started/basic/viz_embeddings.md
@@ -73,12 +71,13 @@ nav:
7371
- Model Fine-Tuning: getting_started/basic/fine_tuning.md
7472
- Model Evaluation: getting_started/basic/model_eval.md
7573
- What's Next: getting_started/basic/next_steps.md
76-
- Troubleshooting: getting_started/basic/troubleshooting.md
7774
- Focused Getting Starteds:
7875
- getting_started/focused_getting_starteds/index.md
7976
- Medical Imaging: getting_started/focused_getting_starteds/medical_imaging/index.md
8077
- FiftyOne Concepts:
8178
- fiftyone_concepts/index.md
79+
- Virtualenvs: fiftyone_concepts/virtualenv.md
80+
- Installation: fiftyone_concepts/install.md
8281
- Basics: fiftyone_concepts/basics.md
8382
- Running Environments: fiftyone_concepts/running_environments.md
8483
- Loading Data into FiftyOne:
@@ -96,7 +95,8 @@ nav:
9695
- Exporting Datasets: fiftyone_concepts/export_datasets.md
9796
- Drawing Labels on Samples: fiftyone_concepts/draw_labels.md
9897
- Configuring FiftyOne: fiftyone_concepts/config.md
99-
- Machine Learning (FiftyOne Brain): fiftyone_concepts/brain.md
98+
- FiftyOne Brain (Machine Learning): fiftyone_concepts/brain.md
99+
- Troubleshooting: fiftyone_concepts/troubleshooting.md
100100
- How Do I:
101101
- how_do_i/index.md
102102
- Cheat Sheets: how_do_i/cheat_sheets/index.md

0 commit comments

Comments
 (0)