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.

Sign up for GitHub

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

Docs: Add notes on 'build targets' on Get Started #1021

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Add notes on 'build targets' on Get Started #1021

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion docusaurus/docs/get-started/get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ To build for production, run:

### Build the backend

If your plugin includes a [backend](../key-concepts/backend-plugins/index.md) component, you can build using mage:
If your plugin includes a [backend](../key-concepts/backend-plugins/index.md) component, you can build using Mage:

```shell
mage -v build:linux
Expand All @@ -243,13 +243,20 @@ mage -v build:linux
| Option | Description | Example |
| -------------- | -------------------------------------------- | --------------------- |
| `build:[arch]` | Builds a binary for a specific architecture. | `mage -v build:Linux` |
| `build:backend` | Builds a production build for the current platform. | `mage -v build:backend` |

List all available Mage targets for additional commands:

```bash
mage -l
```

:::note

There is a mismatch between AMD, ARM64, and the Docker container which may cause the backend Delve debugger dev env to fail to run on Apple silicon.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oshirohugo can you confirm this is still the case?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was improved, but it seems it still not perfect and it will only work in Apple silicon after two runs.
@jackw you worked on that, can you confirm?

Copy link
Collaborator

@jackw jackw Oct 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oshirohugo I'll do some testing here and get back to you. It was a while since I tried this debugger.

Either way you cannot have a mismatch between arch related things (go, dlv and docker image) as it prevents the debugger from connecting from within the container to the host.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jackw Do you still feel this needs further testing, or are we ok to merge?


:::

### Run the Grafana server

To launch the Grafana development server using Docker, run:
Expand Down
Loading