diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 9e2d01763d..0000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: "🐞 Bug report" -about: Report broken functionality or incorrect documentation -labels: "bug" ---- - -**Description** - - -- Version: -- Platform: -- Data source (e.g. bag file, mcap file, rosbridge, ROS 1/2 native): - -**Steps To Reproduce** - - - -**Expected Behavior** diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index a0a871dfed..0000000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,14 +0,0 @@ -blank_issues_enabled: false -contact_links: - - name: "🙋‍♀️ Question" - url: https://github.com/orgs/foxglove/discussions/new/choose - about: Search discussions or ask our community for help - - name: "🚀 Feature request" - url: https://github.com/orgs/foxglove/discussions/new/choose - about: Search existing feature requests or share a new idea - - name: "📚 Stack Exchange" - url: https://robotics.stackexchange.com/questions/ask - about: Get help from the robotics community - - name: "💬 Live chat" - url: https://foxglove.dev/slack - about: Join the discussion in our Slack community diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 78ccd6d900..0000000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,9 +0,0 @@ -**User-Facing Changes** - - -**Description** - - - - - diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index d3734345a6..0000000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -1,131 +0,0 @@ -name: CI - -on: - push: - branches: [main, release/*] - pull_request: - -jobs: - test: - runs-on: ${{ matrix.os }} - - # Run each command in parallel with the same setup steps. - strategy: - fail-fast: false - matrix: - os: - - ubuntu-20.04 - config: - # Specify names so that the GitHub branch protection settings for - # required checks don't need to change if we ever change the commands used. - - name: lint - command: | - # lint steps - set -x - yarn license-check - yarn dedupe --check - yarn run tsc --noEmit # typecheck files that are not included by webpack or package builds - yarn run lint:ci - yarn run lint:unused-exports - yarn run lint:dependencies - - name: packages - command: yarn run build:packages - - name: web - command: yarn run web:build:prod - - name: build benchmark - command: yarn run benchmark:build:prod - - name: test - command: yarn run test --maxWorkers=100% - include: - - os: windows-2019 - config: - name: packages - command: echo complete - - name: ${{ matrix.config.name }} (${{ matrix.os }}) - - steps: - - uses: actions/checkout@v4.1.1 - with: - lfs: true - - - uses: actions/setup-node@v4.0.2 - with: - node-version: 16.17 - - run: corepack enable yarn - - - name: Restore cache - uses: actions/cache@v4.0.1 - with: - path: | - .yarn/cache - **/node_modules - key: v5-${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - restore-keys: v5-${{ runner.os }}-yarn- - - - run: yarn install --immutable - - - run: ${{ matrix.config.command }} - - storybook: - name: storybook (ubuntu-20.04) - runs-on: ubuntu-20.04 - - steps: - - uses: actions/checkout@v4.1.1 - with: - fetch-depth: 0 # Required for Chromatic - lfs: true - - - uses: actions/setup-node@v4.0.2 - with: - node-version: 16.17 - - run: corepack enable yarn - - - name: Restore cache - uses: actions/cache@v4.0.1 - with: - path: | - .yarn/cache - **/node_modules - key: v5-${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - restore-keys: v5-${{ runner.os }}-yarn- - - - run: yarn install --immutable - - - run: yarn workspace @foxglove/studio-base run storybook:build - - integration: - runs-on: ${{ matrix.os }} - timeout-minutes: 10 - strategy: - fail-fast: false - matrix: - os: [ubuntu-20.04] - - name: integration (${{ matrix.os }}) - - steps: - - uses: actions/checkout@v4.1.1 - with: - lfs: true - - - uses: actions/setup-node@v4.0.2 - with: - node-version: 16.17 - - run: corepack enable yarn - - - name: Restore cache - uses: actions/cache@v4.0.1 - with: - path: | - .yarn/cache - **/node_modules - key: v5-${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - restore-keys: v5-${{ runner.os }}-yarn- - - - run: yarn install --immutable - - - name: test:web-integration - if: matrix.os == 'ubuntu-20.04' - run: yarn run test:web-integration diff --git a/README.md b/README.md index dbc39cee3f..558608f917 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@
+> [!NOTE] +> Foxglove Studio 1.x is no longer supported. To install the latest release, please visit our [downloads page](https://foxglove.dev/download). Learn more in our [Foxglove 2.0 announcement](https://foxglove.dev/blog/foxglove-2-0-unifying-robotics-observability). +

Foxglove Studio

- @@ -12,85 +14,47 @@
Download   •   - Docs + Docs +   •   + Changelog   •   - Blog + Discussions   •   Slack   •   - Twitter + X   •   - Contact Us + LinkedIn +   •   + Contact

-[Foxglove](https://foxglove.dev) is an integrated visualization and diagnosis tool for robotics. +Foxglove is a visualization and observability platform for robotics development.

- Foxglove Studio screenshot + Foxglove screenshot

-
- -To learn more, visit the following resources: - -[About](https://foxglove.dev/about) - •  -[Documentation](https://docs.foxglove.dev/docs) - •  -[Release notes](https://github.com/foxglove/studio/releases) - •  -[Blog](https://foxglove.dev/blog) - -You can join us on the following platforms to ask questions, share feedback, and stay up to date on what our team is working on: - -[GitHub Discussions](https://github.com/orgs/foxglove/discussions) - •  -[Slack](https://foxglove.dev/slack) - •  -[Newsletter](https://foxglove.dev/#footer) - •  -[Twitter](https://twitter.com/foxglovedev) - •  -[LinkedIn](https://www.linkedin.com/company/foxglovedev/) - -
- ## Installation -Foxglove Studio is available online at [app.foxglove.dev](https://app.foxglove.dev/), or desktop releases can be downloaded from [foxglove.dev/download](https://foxglove.dev/download). - -## Open Source - -Foxglove Studio follows an open core licensing model. Most functionality is available in this repository, and can be reproduced or modified per the terms of the [Mozilla Public License v2.0](/LICENSE). - -The official binary distributions available at [app.foxglove.dev](https://app.foxglove.dev/) or [foxglove.dev/download](https://foxglove.dev/download) incorporate some closed-source functionality, such as integration with [Foxglove Data Platform](https://foxglove.dev/data-platform), multiple layouts, private extensions, and more. For more information on free and paid features, see our [Pricing](https://foxglove.dev/pricing). - -## Self-hosting - -Foxglove Studio can be self-hosted using our [docker image](https://ghcr.io/foxglove/studio). Please note that this build does not contain any closed source functionality. - -```sh -docker run --rm -p "8080:8080" ghcr.io/foxglove/studio:latest -``` - -Foxglove Studio will be accessible in your browser at [localhost:8080](http://localhost:8080/). +[Create a free account](https://app.foxglove.dev/signup) or [download Foxglove](https://foxglove.dev/download) for Linux, Windows, or macOS to get started. -### Overriding the default layout +## Documentation -[Bind-mount](https://docs.docker.com/storage/bind-mounts/) a layout JSON file at `/foxglove/default-layout.json` to set the default layout used when loading Studio from the Docker image. +Documentation is hosted at [docs.foxglove.dev](https://docs.foxglove.dev/). -```sh -docker run --rm -p "8080:8080" -v /path/to/custom_layout.json:/foxglove/default-layout.json ghcr.io/foxglove/studio:latest -``` +## Support -## Contributing +Support for Foxglove is available via the following channels: -Foxglove Studio is written in TypeScript – contributions are welcome! +- [GitHub Discussions](https://github.com/orgs/foxglove/discussions) +- [Foxglove Community Slack](https://foxglove.dev/slack) +- [Contact Us](https://foxglove.dev/contact) -Note: All contributors must agree to our [Contributor License Agreement](https://github.com/foxglove/cla). See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. +## License -## Credits +This project is availabile under the [Mozilla Public License v2.0](/LICENSE). -Foxglove Studio originally began as a fork of [Webviz](https://github.com/cruise-automation/webviz), an open source project developed by [Cruise](https://getcruise.com/). Most of the Webviz code has been rewritten, but some files still carry a Cruise license header where appropriate. +Foxglove is a trademark of Foxglove Technologies Inc.