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

[HOLD] Update Docs for Fiftyone Enterprise #5096

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 6 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
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ Check out the existing patterns in the source files and you'll catch on.
For Voxel51 developers who are working with a source install of the FiftyOne
Brain: the build script will automatically use your source install!

### Teams SDK
### Enterprise SDK

Voxel51 developers can include Teams SDK-related components in their local docs
build by including the `-t` flag:
Voxel51 developers can include Enterprise SDK-related components in their local
docs build by including the `-t` flag:

```shell
bash docs/generate_docs.bash -t /path/to/fiftyone-teams
Expand Down
2 changes: 1 addition & 1 deletion docs/generate_docs.bash
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Options:
-f Perform a fast build (don't regenerate zoo/plugin docs).
-c Perform a clean build (deletes existing build directory).
-s Copy static files only (CSS, JS).
-t Path to fiftyone-teams clone to use for Teams docs
-t Path to fiftyone-teams clone to use for Enterprise docs
"
}

Expand Down
4 changes: 2 additions & 2 deletions docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<div class="arrow-up--light-primary arrow-left20"></div>
<ul>
<li><a href="{{link_fiftyone}}">Open Source</a></li>
<li><a href="{{link_fiftyone_teams}}">FiftyOne Teams</a></li>
<li><a href="{{link_fiftyone_teams}}">FiftyOne Enterprise</a></li>
<li><a href="{{link_usecases}}">Use Cases</a></li>
<li><a href="{{link_success_stories}}">Success Stories</a></li>
</ul>
Expand Down Expand Up @@ -132,7 +132,7 @@
<div class="footer__links--col2">
<p class="nav__item--brand">Products</p>
<a href="{{link_fiftyone}}">FiftyOne</a>
<a href="{{link_fiftyone_teams}}">FiftyOne Teams</a>
<a href="{{link_fiftyone_teams}}">FiftyOne Enterprise</a>
<a href="{{link_usecases}}">Use Cases</a>
<a href="{{link_success_stories}}">Success Stories</a>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/source/cheat_sheets/fiftyone_terminology.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ __________
- The :ref:`provided user interface <fiftyone-app>` for graphically
viewing, filtering, and understanding your datasets. Can be launched in
the browser or within notebooks.
* - FiftyOne Teams
* - FiftyOne Enterprise
- `The enterprise-grade suite <https://voxel51.com/fiftyone-teams/>`_
built on top of FiftyOne for collaboration, permissioning, and working
with cloud-backed media.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/deprecation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ Kubernetes 1.27
*Support ended November 1, 2024*

`Kubernetes 1.27 <https://kubernetes.io/releases/>`_
transitioned to `end-of-life` effective July of 2024. FiftyOne Teams
transitioned to `end-of-life` effective July of 2024. FiftyOne Enterprise
releases after October 31, 2024 might no longer be compatible with
Kubernetes 1.27 and older.
2 changes: 1 addition & 1 deletion docs/source/environments/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ environments.
not recommended or officially supported. It is useful only for prototyping.

Our recommended, scalable approach to work with cloud-backed data is
:ref:`FiftyOne Teams <fiftyone-teams>`, an enterprise deployment of
:ref:`FiftyOne Enterprise <fiftyone-teams>`, an enterprise deployment of
FiftyOne with multiuser collaboration features, native cloud dataset
support, and much more!

Expand Down
2 changes: 1 addition & 1 deletion docs/source/faq/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ you can :ref:`load a dataset remotely <remote-data>` and then explore it via an
Can I access data stored in the cloud?
--------------------------------------

Yes! Check out :ref:`FiftyOne Teams <fiftyone-teams>`.
Yes! Check out :ref:`FiftyOne Enterprise <fiftyone-teams>`.

.. _faq-supported-os:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ FiftyOne Installation
.. note::

Need to collaborate on your datasets? Check out
:ref:`FiftyOne Teams <fiftyone-teams>`!
:ref:`FiftyOne Enterprise <fiftyone-teams>`!

.. _install-prereqs:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ us at [email protected].
:hidden:

Overview <self>
FiftyOne Teams 🚀 <teams/index>
FiftyOne Enterprise 🚀 <teams/index>
Installation <getting_started/install>
Environments <environments/index>
Tutorials <tutorials/index>
Expand Down
4 changes: 2 additions & 2 deletions docs/source/plugins/developing_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1323,9 +1323,9 @@ on their execution context from within

.. note::

:ref:`FiftyOne Teams <fiftyone-teams>` users can view the current progress
:ref:`FiftyOne Enterprise <fiftyone-teams>` users can view the current progress
of their delegated operations from the
:ref:`Runs page <teams-managing-delegated-operations>` of the Teams App!
:ref:`Runs page <teams-managing-delegated-operations>` of the Enterprise App!

For your convenience, all builtin methods of the FiftyOne SDK that support
rendering progress bars provide an optional `progress` method that you can use
Expand Down
10 changes: 5 additions & 5 deletions docs/source/plugins/using_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -811,7 +811,7 @@ operator's input modal when executing it from within the App:

.. note::

:ref:`FiftyOne Teams <fiftyone-teams>` users can also specify an optional
:ref:`FiftyOne Enterprise <fiftyone-teams>` users can also specify an optional
delegation target for their delegated operations:

.. code-block:: python
Expand Down Expand Up @@ -857,11 +857,11 @@ curation, and evaluation are performed.

Want to run delegated operations at scale?
`Contact us <https://voxel51.com/get-fiftyone-teams>`_ about
:ref:`FiftyOne Teams <fiftyone-teams>`, an open source-compatible
:ref:`FiftyOne Enterprise <fiftyone-teams>`, an open source-compatible
enterprise deployment of FiftyOne with multiuser collaboration features,
native cloud dataset support, and much more!

Think of FiftyOne Teams as the single source of truth on which you
Think of FiftyOne Enterprise as the single source of truth on which you
co-develop your data and models together 📈

.. _managing-delegated-operations:
Expand Down Expand Up @@ -974,9 +974,9 @@ development environment by following these steps:

Want to run delegated operations at scale in production?
`Contact us <https://voxel51.com/get-fiftyone-teams>`_ about
:ref:`FiftyOne Teams <fiftyone-teams>`, an open source-compatible
:ref:`FiftyOne Enterprise <fiftyone-teams>`, an open source-compatible
enterprise deployment of FiftyOne with multiuser collaboration features,
native cloud dataset support, and much more!

FiftyOne Teams as the single source of truth on which you
FiftyOne Enterprise as the single source of truth on which you
co-develop your data and models together 📈
Loading
Loading