Skip to content

Commit

Permalink
Update resources page and move stuff around
Browse files Browse the repository at this point in the history
  • Loading branch information
yeldarby committed Jan 20, 2025
1 parent 8574515 commit 879cb89
Show file tree
Hide file tree
Showing 15 changed files with 85 additions and 51 deletions.
4 changes: 2 additions & 2 deletions docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ notifications).
## Run via Docker

The preferred way to use Inference is via Docker
(see [Why Docker](/understand/architecture/#why-docker)).
(see [Why Docker](/understand/architecture.md#why-docker)).

[Install Docker](https://docs.docker.com/engine/install/) (and
[NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
Expand Down Expand Up @@ -40,4 +40,4 @@ of your new Inference Server's functionality!
inference server start --dev
```

--8<-- "docs/install/using-your-new-server.md"
--8<-- "install/using-your-new-server.md"
2 changes: 1 addition & 1 deletion docs/install/jetson.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,6 @@ If you are using Docker Compose for your application, the equivalent yaml is:
- NET_BIND_SERVICE
```

--8<-- "docs/install/using-your-new-server.md"
--8<-- "install/using-your-new-server.md"

--8<-- "docs/install/enterprise-considerations.md"
2 changes: 1 addition & 1 deletion docs/install/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,6 @@ If you are using Docker Compose for your application, the equivalent yaml is:
- NET_BIND_SERVICE
```

--8<-- "docs/install/using-your-new-server.md"
--8<-- "install/using-your-new-server.md"

--8<-- "docs/install/enterprise-considerations.md"
2 changes: 1 addition & 1 deletion docs/install/mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@

Your server is now running at [`localhost:9001`](http://localhost:9001) with MPS acceleration.

--8<-- "docs/install/using-your-new-server.md"
--8<-- "install/using-your-new-server.md"
2 changes: 1 addition & 1 deletion docs/install/raspberry-pi.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,6 @@ services:
- NET_BIND_SERVICE
```
--8<-- "docs/install/using-your-new-server.md"
--8<-- "install/using-your-new-server.md"
--8<-- "docs/install/enterprise-considerations.md"
5 changes: 3 additions & 2 deletions docs/install/using-your-new-server.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
## Using Your New Server

Once you have a server running, you can access it via [its API](/api.md) or using
[the Python SDK](/inference_helpers/inference_sdk.md). You can also use it to build Workflows
Once you [have a server running](../install/index.md),
you can access it via [its API](../api.md) or using
[the Python SDK](../inference_helpers/inference_sdk.md). You can also use it to build Workflows
using [the Roboflow Platform UI](https://docs.roboflow.com/workflows/create-a-workflow).

=== "Python SDK"
Expand Down
2 changes: 1 addition & 1 deletion docs/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,6 @@ If you are using Docker Compose for your application, the equivalent yaml is:
- NET_BIND_SERVICE
```

--8<-- "docs/install/using-your-new-server.md"
--8<-- "install/using-your-new-server.md"

--8<-- "docs/install/enterprise-considerations.md"
53 changes: 53 additions & 0 deletions docs/resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
hide:
- toc
---

# Other Resources

<div class="grid cards" markdown>

- **GitHub Repo**

---

The Inference repository contains all of the source code behind
the project. It's the place to go to file issues, make feature
requests, or contribute.

[:fontawesome-brands-github: Go to Repo](https://github.com/roboflow/inference)

- **Roboflow Docs**

---

Roboflow's Platform docs cover using all of the complementary
cloud-connected features to the open source Inference project.

[:fontawesome-solid-book: Go to Docs](https://docs.roboflow.com)

- **Roboflow Forum**

---

Get help from and connect with a community of computer vision enthusiasts

[:fontawesome-regular-comment: Go to Forum](https://discuss.roboflow.com)

- **Roboflow Discord**

---

Chat with the Roboflow Community and Team

[:fontawesome-brands-discord: Go to Chat](https://discord.gg/GbfgXGJ8Bk)

- **Roboflow YouTube**

---

Regular videos with computer Vision news, tutorials, product updates, and more

[:fontawesome-brands-youtube: Go to Channel](https://bit.ly/rf-yt-sub)

</div>
2 changes: 1 addition & 1 deletion docs/start/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ workloads on-premises. This is supported via
[self-hosting on your own cloud](/install/cloud/index.md). Billing is the same
as for self-hosting on an edge device.

--8<-- "docs/install/using-your-new-server.md"
--8<-- "install/using-your-new-server.md"

See [more example Workflows](/workflows/gallery/index.md)
or [start building](/workflows/create_and_run.md).
21 changes: 0 additions & 21 deletions docs/start/understand/resources.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
41 changes: 21 additions & 20 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,10 @@ nav:
- Overview: start/overview.md
- Getting Started: start/getting-started.md
- Understand:
- Architecture: start/understand/architecture.md
- Features: start/understand/features.md
- Vocabulary: start/understand/vocabulary.md
- Alternatives: start/understand/alternatives.md
- More Resources: start/understand/resources.md
- Architecture: understand/architecture.md
- Features: understand/features.md
- Vocabulary: understand/vocabulary.md
- Alternatives: understand/alternatives.md
- Cloud Hosting:
- managed/index.md
- Serverless API: managed/serverless.md
Expand All @@ -55,21 +54,22 @@ nav:
- Azure: install/cloud/azure.md
- GCP: install/cloud/gcp.md
- Other Devices: install/other.md
- Inputs:
- inputs/index.md
- Images: inputs/images.md
- Webcam: inputs/webcam.md
- IP Camera (RTSP):
- inputs/rtsp/index.md
- Reolink: inputs/rtsp/reolink.md
- UniFi: inputs/rtsp/unifi.md
- Recorded Video: inputs/video.md
- Industrial:
- inputs/industrial/index.md
- Basler: inputs/industrial/basler.md
- Lucid: inputs/industrial/lucid.md
- FLIR: inputs/industrial/flir.md
# - Inputs:
# - inputs/index.md
# - Images: inputs/images.md
# - Webcam: inputs/webcam.md
# - IP Camera (RTSP):
# - inputs/rtsp/index.md
# - Reolink: inputs/rtsp/reolink.md
# - UniFi: inputs/rtsp/unifi.md
# - Recorded Video: inputs/video.md
# - Industrial:
# - inputs/industrial/index.md
# - Basler: inputs/industrial/basler.md
# - Lucid: inputs/industrial/lucid.md
# - FLIR: inputs/industrial/flir.md
- Next Steps: start/next.md
- More Resources: resources.md

- Models:
- Run a Model: quickstart/run_a_model.md
Expand Down Expand Up @@ -226,7 +226,8 @@ markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.snippets
- pymdownx.snippets:
base_path: docs
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
Expand Down

0 comments on commit 879cb89

Please sign in to comment.