Docs: Update howto/notebook + READMEs #6782
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jprochazk
added
📖 documentation
Deployed docs
|
|
Do we still use iFrames? |
jprochazk
added a commit
that referenced
this pull request
Jul 5, 2024
emilk
added a commit
that referenced
this pull request
Jul 8, 2024
### Next steps
- Test the release
- If this is an 'alpha' release, you can just merge the pull request.
- Otherwise:
- For any added commits, run the release workflow in 'rc' mode again
- After testing, _ensure that this PR is mergeable to _, then run the
release workflow in 'release' mode
- Once the final release workflow finishes it will create a GitHub
release for you. Then:
- [x] Sanity check the build artifacts:
- [x] pip install: does it install and run?
- [x] cargo install of cli tool: does it install and run?
- [x] C++ SDK zip: does it contain rerun_c for all platforms?
- [x] Populate the release with the changelog and a nice header
video/picture, check , then click .
- [ ] Make sure the [conda feedstock
PR](https://github.com/conda-forge/rerun-sdk-feedstock/pulls) gets
merged. This will be created by the once the GitHub release is created.
- [x] Update the [google colab
notebooks](https://drive.google.com/drive/folders/0AC0q24MFKh3fUk9PVA)
to install this version and re-execute the notebook.
- [ ] Merge this PR
### TODO
- [x] make sure the changelog.md date is correct
- [x] migration guide
- [x] docs update
- [x] mainly mentions/links to the viz/override docs where appropriate
- [x] remove speculative link markers
- [x] including all `attr.docs.unreleased`
- [x] cherrypick:
- [x] #6771
- [x] #6768
- [x] #6781
- [x] #6779
- [x] #6782
- [x] #6783
- [x] make sure nothing is left to be cherry-picked
- [x] Tests
- [x] Windows
- [x] Linux
- [x] MacOS
---------
Co-authored-by: Antoine Beyeler <antoine@rerun.io>
Co-authored-by: Antoine Beyeler <49431240+abey79@users.noreply.github.com>
Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
Co-authored-by: Jan Procházka <honza.spacir@gmail.com>
Co-authored-by: Andreas Reich <andreas@rerun.io>
Co-authored-by: jprochazk <1665677+jprochazk@users.noreply.github.com>
Co-authored-by: Leonard Bruns <roym899@gmail.com>
Co-authored-by: Clement Rey <cr.rey.clement@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Checklist
mainbuild: rerun.io/viewernightlybuild: rerun.io/viewerTo run all checks from
main, comment on the PR with@rerun-bot full-check.