Skip to content

Commit

Permalink
docs: DOC-153: Adjust order in page front matter (HumanSignal#4967)
Browse files Browse the repository at this point in the history
* docs: DOC-153: Adjust order in page front matter

* Update predictions.md
  • Loading branch information
caitlinwheeless authored Oct 25, 2023
1 parent 578228b commit 264098c
Show file tree
Hide file tree
Showing 55 changed files with 114 additions and 104 deletions.
4 changes: 2 additions & 2 deletions docs/scripts/release-notes.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ title: On-Premises Release Notes for Label Studio Enterprise
short: On-Prem Release Notes
type: guide
tier: enterprise
order: 221
order_enterprise: 142
order: 0
order_enterprise: 999
section: "Reference"
meta_title: On-premises release notes for Label Studio Enterprise
meta_description: Review new features, enhancements, and bug fixes for on-premises Label Studio Enterprise installations.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Troubleshoot Label Studio
short: Troubleshooting
type: guide
tier: all
order: 100
order_enterprise: 100
order: 15
order_enterprise: 10
section: "Get started"
meta_title: Troubleshoot Label Studio
meta_description: Troubleshoot common issuesTroubleshoot machine learning with Label Studio configuration and performance so that you can return to your machine learning and data science projects.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/active_learning.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Set up active learning with Label Studio
short: Active learning loop
tier: enterprise
type: guide
order: 304
order_enterprise: 117
order: 0
order_enterprise: 315
meta_title: Set up an active learning loop with Label Studio
meta_description: Set up an end-to-end active learning loop with Label Studio using the ML backend SDK and webhooks to perform model training and predictions and labeling.
section: "Machine learning"
Expand Down
6 changes: 3 additions & 3 deletions docs/source/guide/api.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: API Reference for Label Studio
short: Backend API
short: API usage
type: guide
tier: all
order: 214
order_enterprise: 120
order: 405
order_enterprise: 505
meta_title: API Endpoints
meta_description: API documentation for authenticating, listing data science projects, importing predictions and raw data and exporting annotated data, and user management.
section: "Integration and Development"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/auth_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Set up authentication for Label Studio
short: Set up authentication
tier: enterprise
type: guide
order: 113
order_enterprise: 139
order: 0
order_enterprise: 485
meta_title: Authentication for Label Studio Enterprise
meta_description: Label Studio Enterprise documentation for setting up SSO and LDAP authentication for your data labeling, machine learning, and data science projects.
section: "Install"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Manage billing
type: guide
tier: enterprise
order: 102
order_enterprise: 129
order: 0
order_enterprise: 355
meta_title: Manage billing
meta_description: Manage billing for the plans for Label Studio Enterprise and Teams, monitor your license usage, and explore the small business options with Label Studio Teams and the larger organization options with Label Studio Enterprise.
section: "Billing and Usage"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/comments_notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ short: Comments and notifications
type: guide
tier: enterprise
section: "Labeling"
order: 410
order_enterprise: 113
order: 0
order_enterprise: 115
meta_title: Comment and notification systems in Label Studio
meta_description: The Comments and Notifications feature defines how annotators, reviewers and administrators communicate and receive updates on projects and tasks.
---
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/custom_metric.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Add a custom agreement metric to Label Studio
short: Custom agreement metric
tier: enterprise
type: guide
order: 301
order_enterprise: 115
order: 0
order_enterprise: 265
meta_title: Add a Custom Agreement Metric for Labeling
meta_description: Label Studio Enterprise documentation about how to add a custom agreement metric to use for assessing annotator agreement or the quality of your annotation and prediction results for data labeling and machine learning projects.
section: "Quality control"
Expand Down
3 changes: 2 additions & 1 deletion docs/source/guide/dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Project Performance Dashboards
short: Performance Dashboards
tier: enterprise
type: guide
order_enterprise: 103
order: 0
order_enterprise: 65
meta_title: Manage Role-Based Access Control in Label Studio
meta_description: Manage access and set up permissions with user roles, organizations, and project workspaces for your projects in Label Studio Enterprise.
section: "Project & Team Management"
Expand Down
2 changes: 1 addition & 1 deletion docs/source/guide/dataset_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ short: Create a dataset
date: 2023-08-16 11:52:38
tier: enterprise
order: 0
order_enterprise: 405
order_enterprise: 205
meta_title: Create a Dataset to use with data discovery in Label Studio Enterprise
meta_description: How to create a Dataset in Label Studio Enterprise using Google Cloud, Azure, or AWS.
hide_sidebar: true
Expand Down
2 changes: 1 addition & 1 deletion docs/source/guide/dataset_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Manage datasets
short: Manage datasets
tier: enterprise
order: 0
order_enterprise: 408
order_enterprise: 210
meta_title: Manage a dataset in Label Studio Enterprise
meta_description: How to manage your datasets in Label Studio Enterprise
date: 2023-08-23 12:07:13
Expand Down
2 changes: 1 addition & 1 deletion docs/source/guide/dataset_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Semantic search with datasets
short: Semantic search
tier: enterprise
order: 0
order_enterprise: 412
order_enterprise: 215
meta_title: Semantic search with datasets
meta_description: Use semantic search to refine your datasets.
date: 2023-08-23 12:18:50
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/email_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Set up email backend for Label Studio Enterprise
short: Set up email backend
tier: enterprise
type: guide
order: 113
order_enterprise: 139
order: 0
order_enterprise: 480
meta_title: Email backends in Label Studio
section: "Install"

Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Export annotations and data from Label Studio
short: Export annotations
type: guide
tier: all
order: 206
order_enterprise: 109
order: 270
order_enterprise: 170
meta_title: Export Annotations
meta_description: Label Studio documentation for exporting data labeling annotations to use in machine learning models and data science projects.
section: "Import and Export"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Frontend builds
short: Frontend builds
type: guide
tier: all
order: 219
order_enterprise: 126
order: 430
order_enterprise: 530
meta_title: Customize User Interface
meta_description: Label Studio documentation for integrating the Label Studio frontend interface into your own machine learning or data labeling application workflow.
section: "Integration and Development"
Expand Down
6 changes: 4 additions & 2 deletions docs/source/guide/frontend_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ title: Frontend reference
short: Frontend reference
type: guide
tier: all
order: 220
order_enterprise: 127
order: 435
order_enterprise: 535
meta_title: Frontend Library Reference
meta_description: Reference documentation for implementing the Label Studio Frontend into your own machine learning or data science application workflows.
section: "Integration and Development"
parent: "frontend"
parent_enterprise: "frontend"
---

Label Studio Frontend (LSF) includes several UI options and callbacks that you can use when implementing the frontend with a custom labeling backend, or when customizing the Label Studio interface.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Label Studio
short: Overview
type: guide
tier: all
order: 99
order_enterprise: 99
order: 5
order_enterprise: 5
section: "Get started"
meta_title: Overview of Label Studio
meta_description: Get started with Label Studio by creating projects to label and annotate data for machine learning and data science models.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/helm_values.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Available Helm values for Label Studio Helm Chart
short: Available Helm values
tier: all
type: guide
order: 114
order_enterprise: 141
order: 75
order_enterprise: 463
meta_title: Available Helm values for Label Studio Helm Chart
meta_description: For cases when you want to customize your Label Studio Kubernetes deployment, review these available Helm values that you can set in your Helm chart.
section: "Install"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
type: guide
tier: all
layout: home
order: 999
order_enterprise: 999
order: 9999
order_enterprise: 9999
---
4 changes: 2 additions & 2 deletions docs/source/guide/ingress_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Set up an ingress controller for Label Studio Kubernetes deployments
short: Set up an ingress controller
type: guide
tier: all
order: 111
order_enterprise: 137
order: 65
order_enterprise: 457
meta_title: Set up an ingress controller for Label Studio Kubernetes Deployments
meta_description: Set up an ingress controller to manage load balancing and access to Label Studio Kubernetes deployments for your data science and machine learning projects.
section: "Install"
Expand Down
3 changes: 2 additions & 1 deletion docs/source/guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: Install and upgrade
type: guide
tier: opensource
order: 103
order: 55
order_enterprise: 0
meta_title: Install and Upgrade Label Studio
meta_description: "Label Studio documentation: install and upgrade Label Studio with Docker, pip, and anaconda for your machine learning and data science projects."
section: "Install"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/install_enterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Installation overview
short: Overview
tier: enterprise
type: guide
order: 133
order_enterprise: 133
order: 0
order_enterprise: 452
meta_title: Set up an active learning loop with Label Studio
meta_description: Set up an end-to-end active learning loop with Label Studio using the ML backend SDK and webhooks to perform model training and predictions and labeling.
section: "Install"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/install_enterprise_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Install Label Studio Enterprise On-premises using Docker Compose
short: Docker Compose
type: guide
tier: enterprise
order: 109
order_enterprise: 134
order: 0
order_enterprise: 465
meta_title: Install Label Studio Enterprise on-premises using Docker
meta_description: Install, back up, and upgrade Label Studio Enterprise with Docker to create machine learning and data science projects on-premises.
section: "Install"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/install_enterprise_k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Deploy Label Studio Enterprise on Kubernetes
short: Kubernetes
tier: enterprise
type: guide
order: 108
order_enterprise: 133
order: 0
order_enterprise: 455
meta_title: Deploy Label Studio Enterprise on Kubernetes
meta_description: Deploy Label Studio Enterprise on Kubernetes, such as on Amazon Elastic Container Service for Kubernetes, to create machine learning and data science projects in a scalable containerized environment.
section: "Install"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/install_k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Deploy Label Studio on Kubernetes
short: Kubernetes
tier: opensource
type: guide
order: 106
order_enterprise: 132
order: 60
order_enterprise: 0
meta_title: Deploy Label Studio on Kubernetes
meta_description: Deploy Label Studio on Kubernetes, such as on Amazon Elastic Container Service for Kubernetes, to create machine learning and data science projects in a scalable containerized environment.
section: "Install"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/install_k8s_airgapped.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Install Label Studio without public internet access
short: Airgapped Server
tier: all
type: guide
order: 112
order_enterprise: 135
order: 70
order_enterprise: 460
meta_title: Install Label Studio without public internet access
meta_description: Install Label Studio without public internet access to create machine learning and data science projects in an airgapped environment.
section: "Install"
Expand Down
3 changes: 2 additions & 1 deletion docs/source/guide/label_studio_compare.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Compare Community and Enterprise Features
short: Enterprise vs Community
type: guide
tier: all
order: 100
order: 20
order_enterprise: 15
section: "Get started"
meta_title: Label Studio Community and Enterprise Features
meta_description: Compare the features of Label Studio Community Edition with the paid Label Studio Enterprise Edition so that you can choose the best option for your data labeling and annotation projects.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/labeling.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Label and annotate data
tier: all
type: guide
order: 208
order_enterprise: 112
order: 210
order_enterprise: 110
meta_title: Label and annotate data
meta_description: Label and annotate data to create bounding boxes, label text spans, set up relations. Filter and sort project data for machine learning dataset creation.
section: "Labeling"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/manage_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Manage data for your labeling project
short: Data manager
type: guide
tier: all
order: 207
order_enterprise: 111
order: 205
order_enterprise: 105
meta_title: Manage data for your labeling project
meta_description: Manage, filter, and sort project data for your machine learning data science labeling project.
section: "Labeling"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/manage_projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Manage projects in Label Studio Enterprise
short: Project management
tier: enterprise
type: guide
order: 115
order_enterprise: 103
order: 0
order_enterprise: 60
meta_title: Manage Role-Based Access Control in Label Studio
meta_description: Manage access and set up permissions with user roles, organizations, and project workspaces for your projects in Label Studio Enterprise.
section: "Project & Team Management"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/manage_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Manage users to Label Studio Enterprise
short: User management
tier: enterprise
type: guide
order: 115
order_enterprise: 102
order: 0
order_enterprise: 70
meta_title: Manage Role-Based Access Control in Label Studio
meta_description: Manage access and set up permissions with user roles, organizations, and project workspaces for your projects in Label Studio Enterprise.
section: "Project & Team Management"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/ml.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Integrate Label Studio into your machine learning pipeline
short: Machine learning integration
type: guide
tier: all
order: 209
order_enterprise: 116
order: 355
order_enterprise: 305
meta_title: Integrate Label Studio into your machine learning pipeline
meta_description: Machine learning frameworks for integrating your model development pipeline seamlessly with your data labeling workflow.
section: "Machine learning"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/ml_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Write your own ML backend
short: Write your own ML backend
type: guide
tier: all
order: 210
order_enterprise: 117
order: 360
order_enterprise: 310
meta_title: Machine Learning SDK
meta_description: Set up your machine learning model to output and consume predictions in your data science and data labeling projects.
section: "Machine learning"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/ml_troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Troubleshoot machine learning
short: Troubleshooting
type: guide
tier: all
order: 213
order_enterprise: 119
order: 370
order_enterprise: 325
meta_title: Troubleshoot Machine Learning
meta_description: Troubleshoot Label Studio connections with machine learning frameworks using the Label Studio ML backend SDK.
section: "Machine learning"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/ml_tutorials.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: ML Examples and Tutorials
type: guide
tier: all
order: 211
order_enterprise: 118
order: 365
order_enterprise: 320
section: "Machine learning"
meta_title: Machine Learning Example Tutorials
meta_description: Tutorial documentation for setting up a machine learning model with predictions using PyTorch, GPT2, Sci-kit learn, and other popular frameworks.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guide/persistent_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Set up persistent storage
type: guide
tier: all
order: 112
order_enterprise: 138
order: 85
order_enterprise: 475
meta_title: Set up persistent storage with Label Studio
meta_description: Configure persistent storage with Label Studio hosted in the cloud to store uploaded data such as task data, user images, and more.
section: "Install"
Expand Down
Loading

0 comments on commit 264098c

Please sign in to comment.