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

Change head metadata from position: to sidebar_position #19

Merged
merged 2 commits into from
Dec 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Integrating new tools without plugins
position: 999
sidebar_position: 999
---

---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributions/contribution-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Contribution overview
position: 0
sidebar_position: 0
---

The flow for making changes to Pants.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/contributions/development/developing-rust.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Developing Rust
position: 2
sidebar_position: 2
---

Hacking on the Pants engine in Rust.
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributions/development/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Development
position: 1
sidebar_position: 1
---

How to make code changes to Pants.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Internal architecture
position: 3
sidebar_position: 3
---

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Running Pants from sources
position: 5
sidebar_position: 5
---

---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributions/development/setting-up-pants.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Setting up Pants
position: 0
sidebar_position: 0
---

How to set up Pants for local development.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributions/development/style-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Style guide
position: 1
sidebar_position: 1
---

Some conventions we encourage.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: GitHub Actions macOS ARM64 runners
position: 2
sidebar_position: 2
---

---
Expand All @@ -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/).

Expand Down Expand Up @@ -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:

```
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributions/releases/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Releases
position: 2
sidebar_position: 2
---

---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributions/releases/release-process.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Release process
position: 1
sidebar_position: 1
---

How to release a new version of Pants and its plugins.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributions/releases/release-strategy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Release strategy
position: 0
sidebar_position: 0
---

Our approach to semantic versioning + time-based releases.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/docker/docker-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Docker overview
position: 0
sidebar_position: 0
---

How to build Docker images containing artifacts built by Pants
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/docker/tagging-docker-images.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Tagging Docker images
position: 1
sidebar_position: 1
---

How to set registry, repository and tag names on your images
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Example projects and repositories
position: 3
sidebar_position: 3
---

Example projects to help set up your own repository.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Incremental adoption
position: 4
sidebar_position: 4
---

How to incrementally add Pants to an existing repository.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/getting-started/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Getting started
position: 0
sidebar_position: 0
---

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Initial configuration
position: 2
sidebar_position: 2
---

Creating the configuration necessary to run Pants.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Installing Pants
position: 1
sidebar_position: 1
---

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Manual installation
position: 5
sidebar_position: 5
---

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Prerequisites
position: 0
sidebar_position: 0
---

---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/go/go-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Go overview
position: 0
sidebar_position: 0
---

Pants's support for Golang.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/go/integrations/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Integrations
position: 1
sidebar_position: 1
---

Useful integrations for Golang.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/go/integrations/protobuf.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Protobuf
position: 0
sidebar_position: 0
---

How to generate Go from Protocol Buffers.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/helm/deployments.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Deployments
position: 1
sidebar_position: 1
---

---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/helm/helm-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Helm Overview
position: 0
sidebar_position: 0
---

---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/helm/kubeconform.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Kubeconform
position: 999
sidebar_position: 999
---

---
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/introduction/how-does-pants-work.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: How does Pants work?
position: 1
sidebar_position: 1
---

---
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/introduction/welcome-to-pants.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Welcome to Pants!
position: 0
sidebar_position: 0
---

---
Expand Down Expand Up @@ -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?
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/java-and-scala/java-and-scala-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Java and Scala overview
position: 0
sidebar_position: 0
---

Pants's support for Java and Scala.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/java-and-scala/kotlin.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Kotlin
position: 1
sidebar_position: 1
---

Kotlin support for Pants.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/python/goals/check.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: check
position: 0
sidebar_position: 0
---

How to use MyPy.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/python/goals/fmt.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: fmt
position: 1
sidebar_position: 1
---

Autoformat source code.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/python/goals/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Goals
position: 1
sidebar_position: 1
---

Details on the Python-related goals implemented in the Python backend.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/python/goals/lint.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: lint
position: 2
sidebar_position: 2
---

Lint source code.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/python/goals/package.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: package
position: 3
sidebar_position: 3
---

Create a deployable artifact.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/python/goals/publish.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: publish
position: 4
sidebar_position: 4
---

How to distribute packages to a PyPi repository
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/python/goals/repl.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: repl
position: 5
sidebar_position: 5
---

Open a REPL for interactive development.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/python/goals/run.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: run
position: 6
sidebar_position: 6
---

Run a `pex_binary` target.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/python/goals/test.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: test
position: 7
sidebar_position: 7
---

Run tests with Pytest.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/python/integrations/aws-lambda.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: AWS Lambda
position: 2
sidebar_position: 2
---

Create a Lambda with Python code.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/python/integrations/google-cloud-functions.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Google Cloud Functions
position: 3
sidebar_position: 3
---

Create a Cloud Function with Python.
Expand Down
Loading