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

Add orbstack guide #856

Merged
merged 1 commit into from
Dec 30, 2024
Merged

Add orbstack guide #856

merged 1 commit into from
Dec 30, 2024

Conversation

lewiszlw
Copy link
Member

No description provided.

For MacOS users, you can install [OrbStack](https://orbstack.dev/) as a docker alternative.
For MacOS users, you can install [OrbStack as a docker alternative](docs/contributing/orbstack.md).
Copy link
Contributor

@xxchan xxchan Dec 28, 2024

Choose a reason for hiding this comment

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

Adding guide about how to use a tool seems strange to me, unless we need project-specific settings. It should be enough to link to the tool's doc

Copy link
Member Author

Choose a reason for hiding this comment

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

We have podman guide in repo. I think adding orbstack guide is helpful to new contributer as it's not trival to run tests like other rust projects, we should lower the threshold for new contributers as much as possible.

Copy link
Contributor

@liurenjie1024 liurenjie1024 left a comment

Choose a reason for hiding this comment

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

Thanks @lewiszlw for this pr. I'm fine with adding some simple doc to help first time contributor.

@liurenjie1024 liurenjie1024 merged commit 044750f into apache:main Dec 30, 2024
16 checks passed

```
{
"registry-mirrors": ["https://registry.docker.ir", "https://docker.iranserver.com"]
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: why are these registry mirrors part of the PR? The only reference i can find about these registry mirrors is here orbstack/orbstack#51 (comment)

It doesnt seem like these mirrors are commonly used

can we remove this recommendation or change it to a more commonly used mirror?
cc @liurenjie1024 @lewiszlw

Copy link
Member Author

Choose a reason for hiding this comment

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

These registry mirrors are just example, copied from orbstack/orbstack#51 (comment) . I think we can change it like

{
        "registry-mirrors": ["<mirror_addr>"]
}

Copy link
Contributor

@kevinjqliu kevinjqliu Dec 31, 2024

Choose a reason for hiding this comment

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

that sounds good to me, thanks!

Let's see if I can change it right here from github:

Suggested change
"registry-mirrors": ["https://registry.docker.ir", "https://docker.iranserver.com"]
"registry-mirrors": ["<mirror_addr>"]

edit: guess not since its already merged. Would you like to make the change?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants