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

docs: need to explain how to run headless #222

Open
eseidel opened this issue Apr 25, 2024 · 3 comments
Open

docs: need to explain how to run headless #222

eseidel opened this issue Apr 25, 2024 · 3 comments
Labels
good first issue Good for newcomers

Comments

@eseidel
Copy link
Contributor

eseidel commented Apr 25, 2024

Our headless detection is clearly not working well enough yet. We should also just add some docs about specifying CI=1 or whatever is is we need.

e.g. https://discord.com/channels/1030243211995791380/1189097166476673075/1233055119063515157

@eseidel
Copy link
Contributor Author

eseidel commented Apr 25, 2024

We should just add a generic "configuring for CI" page https://docs.shorebird.dev/ci

@eseidel
Copy link
Contributor Author

eseidel commented Apr 25, 2024

Would like a generic CI page which says:

  • shorebird is designed to work well in CI
  • shorebird tries to detect if it's running in CI.
  • If shorebird fails to detect for some reason: 1. file an issue with us. 2. use CI=1
    Maybe gives generic tips as to the steps involved?

@eseidel eseidel added the good first issue Good for newcomers label Apr 25, 2024
@eseidel
Copy link
Contributor Author

eseidel commented Apr 25, 2024

I think the only thing stopping me from writing this is I don't know how to put the page at https://docs.shorebird.dev/ci itself. I guess I could make a https://docs.shorebird.dev/ci/other url or something.

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

No branches or pull requests

1 participant