sidebar_position

pantsbuild · Dec 29, 2023 · 80fdd2a · 80fdd2a
1 parent 22babb7
commit 80fdd2a
Show file tree

Hide file tree

Showing 2,120 changed files with 2,201 additions and 2,201 deletions.
diff --git a/docs/docs/ad-hoc-tools/integrating-new-tools-without-plugins.mdx b/docs/docs/ad-hoc-tools/integrating-new-tools-without-plugins.mdx
@@ -1,6 +1,6 @@
 ---
     title: Integrating new tools without plugins
-    position: 999
+    sidebar_position: 999
 ---
 
 ---

diff --git a/docs/docs/contributions/contribution-overview.mdx b/docs/docs/contributions/contribution-overview.mdx
@@ -1,6 +1,6 @@
 ---
     title: Contribution overview
-    position: 0
+    sidebar_position: 0
 ---
 
 The flow for making changes to Pants.

diff --git a/docs/docs/contributions/development/debugging-and-benchmarking.mdx b/docs/docs/contributions/development/debugging-and-benchmarking.mdx
@@ -1,6 +1,6 @@
 ---
     title: Debugging and benchmarking
-    position: 4
+    sidebar_position: 4
 ---
 
 Some techniques to figure out why Pants is behaving the way it is.

diff --git a/docs/docs/contributions/development/developing-rust.mdx b/docs/docs/contributions/development/developing-rust.mdx
@@ -1,6 +1,6 @@
 ---
     title: Developing Rust
-    position: 2
+    sidebar_position: 2
 ---
 
 Hacking on the Pants engine in Rust.
@@ -84,7 +84,7 @@ To enable logging:
 2.  At the start of your test, add `let _logger = env_logger::try_init();`.
 3.  Add log statements wherever you'd like using `log::info!()` et al.
 4.  Run your test with `RUST_LOG=trace ./cargo test -p $crate test_name -- --nocapture`, using one of `error`, `warn`, `info`, `debug`, or `trace`.
-  
+
 :::
 
 ### Autoformat

diff --git a/docs/docs/contributions/development/index.mdx b/docs/docs/contributions/development/index.mdx
@@ -1,6 +1,6 @@
 ---
     title: Development
-    position: 1
+    sidebar_position: 1
 ---
 
 How to make code changes to Pants.

diff --git a/docs/docs/contributions/development/internal-architecture.mdx b/docs/docs/contributions/development/internal-architecture.mdx
@@ -1,6 +1,6 @@
 ---
     title: Internal architecture
-    position: 3
+    sidebar_position: 3
 ---
 
 ---

diff --git a/docs/docs/contributions/development/running-pants-from-sources.mdx b/docs/docs/contributions/development/running-pants-from-sources.mdx
@@ -1,6 +1,6 @@
 ---
     title: Running Pants from sources
-    position: 5
+    sidebar_position: 5
 ---
 
 ---

diff --git a/docs/docs/contributions/development/setting-up-pants.mdx b/docs/docs/contributions/development/setting-up-pants.mdx
@@ -1,6 +1,6 @@
 ---
     title: Setting up Pants
-    position: 0
+    sidebar_position: 0
 ---
 
 How to set up Pants for local development.

diff --git a/docs/docs/contributions/development/style-guide.mdx b/docs/docs/contributions/development/style-guide.mdx
@@ -1,6 +1,6 @@
 ---
     title: Style guide
-    position: 1
+    sidebar_position: 1
 ---
 
 Some conventions we encourage.

diff --git a/docs/docs/contributions/releases/github-actions-macos-arm64-runners.mdx b/docs/docs/contributions/releases/github-actions-macos-arm64-runners.mdx
@@ -1,6 +1,6 @@
 ---
     title: GitHub Actions macOS ARM64 runners
-    position: 2
+    sidebar_position: 2
 ---
 
 ---
@@ -16,7 +16,7 @@ If you find any errors or omissions in this page, please let us know on [Slack](
 As yet there aren't many options for a hosted M1 system:
 
 - AWS has a [preview program](https://aws.amazon.com/about-aws/whats-new/2021/12/amazon-ec2-m1-mac-instances-macos/), which you can sign up for and hope to get into. Once these instances are generally available we can evaluate them as a solution.
-- You can buy an M1 machine and stick it in a closet. You take on the risk of compromising your  
+- You can buy an M1 machine and stick it in a closet. You take on the risk of compromising your
   network if the machine is compromised by a rogue CI job.
 - You can rent a cloud-hosted M1 machine by the month from [MacStadium](https://www.macstadium.com/).
 
@@ -194,7 +194,7 @@ As `gha`, run:
 
 ## Testing it all out
 
-Now use the MacStadium web UI to restart the machine. Once it comes back up it  
+Now use the MacStadium web UI to restart the machine. Once it comes back up it
 should be able to pick up any job with this setting:
 
 ```

diff --git a/docs/docs/contributions/releases/index.mdx b/docs/docs/contributions/releases/index.mdx
@@ -1,6 +1,6 @@
 ---
     title: Releases
-    position: 2
+    sidebar_position: 2
 ---
 
 ---

diff --git a/docs/docs/contributions/releases/release-process.mdx b/docs/docs/contributions/releases/release-process.mdx
@@ -1,6 +1,6 @@
 ---
     title: Release process
-    position: 1
+    sidebar_position: 1
 ---
 
 How to release a new version of Pants and its plugins.

diff --git a/docs/docs/contributions/releases/release-strategy.mdx b/docs/docs/contributions/releases/release-strategy.mdx
@@ -1,6 +1,6 @@
 ---
     title: Release strategy
-    position: 0
+    sidebar_position: 0
 ---
 
 Our approach to semantic versioning + time-based releases.

diff --git a/docs/docs/docker/docker-overview.mdx b/docs/docs/docker/docker-overview.mdx
@@ -1,6 +1,6 @@
 ---
     title: Docker overview
-    position: 0
+    sidebar_position: 0
 ---
 
 How to build Docker images containing artifacts built by Pants

diff --git a/docs/docs/docker/tagging-docker-images.mdx b/docs/docs/docker/tagging-docker-images.mdx
@@ -1,6 +1,6 @@
 ---
     title: Tagging Docker images
-    position: 1
+    sidebar_position: 1
 ---
 
 How to set registry, repository and tag names on your images

diff --git a/docs/docs/getting-started/getting-started/example-projects-and-repositories.mdx b/docs/docs/getting-started/getting-started/example-projects-and-repositories.mdx
@@ -1,6 +1,6 @@
 ---
     title: Example projects and repositories
-    position: 3
+    sidebar_position: 3
 ---
 
 Example projects to help set up your own repository.

diff --git a/docs/docs/getting-started/getting-started/incremental-adoption.mdx b/docs/docs/getting-started/getting-started/incremental-adoption.mdx
@@ -1,6 +1,6 @@
 ---
     title: Incremental adoption
-    position: 4
+    sidebar_position: 4
 ---
 
 How to incrementally add Pants to an existing repository.

diff --git a/docs/docs/getting-started/getting-started/index.mdx b/docs/docs/getting-started/getting-started/index.mdx
@@ -1,6 +1,6 @@
 ---
     title: Getting started
-    position: 0
+    sidebar_position: 0
 ---
 
 ---

diff --git a/docs/docs/getting-started/getting-started/initial-configuration.mdx b/docs/docs/getting-started/getting-started/initial-configuration.mdx
@@ -1,6 +1,6 @@
 ---
     title: Initial configuration
-    position: 2
+    sidebar_position: 2
 ---
 
 Creating the configuration necessary to run Pants.

diff --git a/docs/docs/getting-started/getting-started/installing-pants.mdx b/docs/docs/getting-started/getting-started/installing-pants.mdx
@@ -1,6 +1,6 @@
 ---
     title: Installing Pants
-    position: 1
+    sidebar_position: 1
 ---
 
 ---

diff --git a/docs/docs/getting-started/getting-started/manual-installation.mdx b/docs/docs/getting-started/getting-started/manual-installation.mdx
@@ -1,6 +1,6 @@
 ---
     title: Manual installation
-    position: 5
+    sidebar_position: 5
 ---
 
 ---

diff --git a/docs/docs/getting-started/getting-started/prerequisites.mdx b/docs/docs/getting-started/getting-started/prerequisites.mdx
@@ -1,6 +1,6 @@
 ---
     title: Prerequisites
-    position: 0
+    sidebar_position: 0
 ---
 
 ---

diff --git a/docs/docs/go/go-overview.mdx b/docs/docs/go/go-overview.mdx
@@ -1,6 +1,6 @@
 ---
     title: Go overview
-    position: 0
+    sidebar_position: 0
 ---
 
 Pants's support for Golang.

diff --git a/docs/docs/go/integrations/index.mdx b/docs/docs/go/integrations/index.mdx
@@ -1,6 +1,6 @@
 ---
     title: Integrations
-    position: 1
+    sidebar_position: 1
 ---
 
 Useful integrations for Golang.

diff --git a/docs/docs/go/integrations/protobuf.mdx b/docs/docs/go/integrations/protobuf.mdx
@@ -1,6 +1,6 @@
 ---
     title: Protobuf
-    position: 0
+    sidebar_position: 0
 ---
 
 How to generate Go from Protocol Buffers.

diff --git a/docs/docs/helm/deployments.mdx b/docs/docs/helm/deployments.mdx
@@ -1,6 +1,6 @@
 ---
     title: Deployments
-    position: 1
+    sidebar_position: 1
 ---
 
 ---

diff --git a/docs/docs/helm/helm-overview.mdx b/docs/docs/helm/helm-overview.mdx
@@ -1,6 +1,6 @@
 ---
     title: Helm Overview
-    position: 0
+    sidebar_position: 0
 ---
 
 ---

diff --git a/docs/docs/helm/kubeconform.mdx b/docs/docs/helm/kubeconform.mdx
@@ -1,6 +1,6 @@
 ---
     title: Kubeconform
-    position: 999
+    sidebar_position: 999
 ---
 
 ---

diff --git a/docs/docs/introduction/how-does-pants-work.mdx b/docs/docs/introduction/how-does-pants-work.mdx
@@ -1,6 +1,6 @@
 ---
     title: How does Pants work?
-    position: 1
+    sidebar_position: 1
 ---
 
 ---

diff --git a/docs/docs/introduction/welcome-to-pants.mdx b/docs/docs/introduction/welcome-to-pants.mdx
@@ -1,6 +1,6 @@
 ---
     title: Welcome to Pants!
-    position: 0
+    sidebar_position: 0
 ---
 
 ---
@@ -42,7 +42,7 @@ Pants is designed for fast, consistent, ergonomic builds. Some noteworthy featur
 - Pants supports a wide range of code generators (such as Thrift, Protobuf, Scrooge and Avro), linters and formatters, and it is easy to add support for new or custom ones
 - Pants can create standalone binaries, [Docker images](../docker/docker-overview.mdx), AWS Lambdas and GCP Cloud Functions
 
-We're listening to the community for which languages, frameworks and tools we should support next, so let us know about your needs by [opening an issue](https://github.com/pantsbuild/pants/issues/new/choose) on GitHub or [chatting with us](/community/members) about it on the community Slack!  
+We're listening to the community for which languages, frameworks and tools we should support next, so let us know about your needs by [opening an issue](https://github.com/pantsbuild/pants/issues/new/choose) on GitHub or [chatting with us](/community/members) about it on the community Slack!
 Pants was designed for extensibility, and we welcome [contributions](../contributions/contribution-overview.mdx)!
 
 # How does Pants work?

diff --git a/docs/docs/java-and-scala/java-and-scala-overview.mdx b/docs/docs/java-and-scala/java-and-scala-overview.mdx
@@ -1,6 +1,6 @@
 ---
     title: Java and Scala overview
-    position: 0
+    sidebar_position: 0
 ---
 
 Pants's support for Java and Scala.

diff --git a/docs/docs/java-and-scala/kotlin.mdx b/docs/docs/java-and-scala/kotlin.mdx
@@ -1,6 +1,6 @@
 ---
     title: Kotlin
-    position: 1
+    sidebar_position: 1
 ---
 
 Kotlin support for Pants.

diff --git a/docs/docs/python/goals/check.mdx b/docs/docs/python/goals/check.mdx
@@ -1,6 +1,6 @@
 ---
     title: check
-    position: 0
+    sidebar_position: 0
 ---
 
 How to use MyPy.

diff --git a/docs/docs/python/goals/fmt.mdx b/docs/docs/python/goals/fmt.mdx
@@ -1,6 +1,6 @@
 ---
     title: fmt
-    position: 1
+    sidebar_position: 1
 ---
 
 Autoformat source code.

diff --git a/docs/docs/python/goals/index.mdx b/docs/docs/python/goals/index.mdx
@@ -1,6 +1,6 @@
 ---
     title: Goals
-    position: 1
+    sidebar_position: 1
 ---
 
 Details on the Python-related goals implemented in the Python backend.

diff --git a/docs/docs/python/goals/lint.mdx b/docs/docs/python/goals/lint.mdx
@@ -1,6 +1,6 @@
 ---
     title: lint
-    position: 2
+    sidebar_position: 2
 ---
 
 Lint source code.

diff --git a/docs/docs/python/goals/package.mdx b/docs/docs/python/goals/package.mdx
@@ -1,6 +1,6 @@
 ---
     title: package
-    position: 3
+    sidebar_position: 3
 ---
 
 Create a deployable artifact.

diff --git a/docs/docs/python/goals/publish.mdx b/docs/docs/python/goals/publish.mdx
@@ -1,6 +1,6 @@
 ---
     title: publish
-    position: 4
+    sidebar_position: 4
 ---
 
 How to distribute packages to a PyPi repository

diff --git a/docs/docs/python/goals/repl.mdx b/docs/docs/python/goals/repl.mdx
@@ -1,6 +1,6 @@
 ---
     title: repl
-    position: 5
+    sidebar_position: 5
 ---
 
 Open a REPL for interactive development.

diff --git a/docs/docs/python/goals/run.mdx b/docs/docs/python/goals/run.mdx
@@ -1,6 +1,6 @@
 ---
     title: run
-    position: 6
+    sidebar_position: 6
 ---
 
 Run a `pex_binary` target.
@@ -65,7 +65,7 @@ On the other hand, if your app is short lived (like a script) and you'd like to
 1. In your editor, set your breakpoints and any other debug settings (like break-on-exception).
 2. Run your code with `pants run --debug-adapter`.
 3. Connect your editor to the server. The server host and port are logged by Pants when executing `run --debug-adapter`. (They can also be configured using the `[debug-adapter]` subsystem).
- 
+
 :::
 
 :::note Tip: Using the IntelliJ/PyCharm remote debugger

diff --git a/docs/docs/python/goals/test.mdx b/docs/docs/python/goals/test.mdx
@@ -1,6 +1,6 @@
 ---
     title: test
-    position: 7
+    sidebar_position: 7
 ---
 
 Run tests with Pytest.
@@ -333,7 +333,7 @@ To run the tests you will need to add `-- -s` to the test call since ipdb will n
 1. In your editor, set your breakpoints and any other debug settings (like break-on-exception).
 2. Run your test with `pants test --debug-adapter`.
 3. Connect your editor to the server. The server host and port are logged by Pants when executing `test --debug-adapter`. (They can also be configured using the `[debug-adapter]` subsystem).
- 
+
 :::
 
 > Run your test with `pants test --debug` as usual.

diff --git a/docs/docs/python/integrations/aws-lambda.mdx b/docs/docs/python/integrations/aws-lambda.mdx
@@ -1,6 +1,6 @@
 ---
     title: AWS Lambda
-    position: 2
+    sidebar_position: 2
 ---
 
 Create a Lambda with Python code.

diff --git a/docs/docs/python/integrations/google-cloud-functions.mdx b/docs/docs/python/integrations/google-cloud-functions.mdx
@@ -1,6 +1,6 @@
 ---
     title: Google Cloud Functions
-    position: 3
+    sidebar_position: 3
 ---
 
 Create a Cloud Function with Python.