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

Release catchup #8

Draft
wants to merge 30 commits into
base: latest
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
928211e
README: reflect in-use project structure
ES-Alexander Dec 19, 2024
a8c29fd
CONTRIBUTING: reflect in-use project structure
ES-Alexander Dec 19, 2024
ac58f86
content: usage: advanced: update interface overview
ES-Alexander Dec 19, 2024
f4ff39e
content: usage: advanced: updated sidebar menu interface
ES-Alexander Dec 19, 2024
84ac16d
content: usage: advanced: update joystick interface
ES-Alexander Dec 19, 2024
3916225
content: usage: installation: add download links
ES-Alexander Dec 20, 2024
bd9f4f5
content: usage: overview: update availability
ES-Alexander Dec 19, 2024
bfbd479
content: usage: advanced: document GoTo functionality
ES-Alexander Dec 30, 2024
d25ddd8
content: usage: advanced: document system logs
ES-Alexander Dec 30, 2024
58f9f05
content: usage: advanced: update telemetry logging info
ES-Alexander Dec 30, 2024
ec55381
content: usage: advanced: update video details
ES-Alexander Dec 30, 2024
1367c66
gitignore: vim swap files
ES-Alexander Dec 31, 2024
da15011
content: usage: advanced: update Views info
ES-Alexander Dec 31, 2024
d188fb0
content: usage: overview: add videos
ES-Alexander Jan 1, 2025
44fde2b
content: usage: overview: add communication links
ES-Alexander Jan 1, 2025
16b8c1a
content: usage: advanced: sidebar-menu: cover About and Fullscreen
ES-Alexander Jan 2, 2025
a337c0e
content: usage: advanced: sidebar-menu: cover interface settings
ES-Alexander Jan 2, 2025
14ff923
content: usage: advanced: update alerts interface
ES-Alexander Jan 2, 2025
9628e17
content: usage: advanced: sidebar-menu: add dev mode settings
ES-Alexander Jan 2, 2025
89def84
content: usage: advanced: sidebar-menu: add mission config
ES-Alexander Jan 2, 2025
afe0c7e
content: usage: advanced: introduce custom Actions
ES-Alexander Jan 2, 2025
164ee7e
content: usage: advanced: update Actions list
ES-Alexander Jan 2, 2025
a7027dd
content: usage: advanced: update widgets
ES-Alexander Jan 5, 2025
e8f3a08
content: usage: advanced: drag regular widgets to add to View
ES-Alexander Jan 5, 2025
d157baf
content: usage: advanced: system logs avoid console logs
ES-Alexander Jan 6, 2025
b968d92
usage: installation: application update
ES-Alexander Jan 6, 2025
cfedf8a
content: usage: advanced: cover users
ES-Alexander Jan 6, 2025
9fed42f
content: usage: advanced: update profiles
ES-Alexander Jan 6, 2025
84e1948
content: usage: joystick updates
ES-Alexander Jan 6, 2025
dbea2b1
content: usage: advanced: attitude HUD camera tilt compensation
ES-Alexander Jan 7, 2025
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
.DS_Store
public

*.swp
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ This file refers to the process of contributing to this documentation repository

## Repository Structure
1. Each branch covers some form of release of the software
- The `latest` and `beta` branches cover the unstable features in development / early testing
- The `X.Y` versioned branches track major and minor stable releases
- The `latest` branch covers the unstable features in development / early testing
- The `stable` and `X.Y` versioned branches track major and minor stable releases
- `stable` documents the current latest stable version
- It only branches into the corresponding numbered branch at the time of the next version number increment
- Patch release (`X.Y.Z`) changes are documented (as relevant) in the corresponding minor release branch (`X.Y`)
1. Documentation content is in the `content` directory
1. The theme is included in the `themes` directory, as a git submodule
Expand All @@ -18,9 +20,7 @@ This file refers to the process of contributing to this documentation repository
- It is recommended that software pull requests that change an interface or part of the documented code structure be marked with a `docs-needed` [label](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels), and include a comment about which aspects need to be documented prior to the feature being merged (while the details are still front of mind for the developer)
- If a software pull request is labelled as `docs-needed`, once a corresponding documentation pull request is merged the feature PR can be re-labelled with a completion status (e.g. `docs-minimal` or `docs-complete`)
- Beta releases may require that no merged features are labelled with `docs-needed`, and stable releases may require that no included features are labelled with `docs-needed` or `docs-minimal`
1. When a new beta release of the software is made, the relevant changes in the `latest` branch get merged or cherry-picked over to the `beta` branch
- This is handled by the documentation maintainers
1. When a new major or minor stable release of the software is made, the `beta` branch gets duplicated into a new branch tracking that version, which then gets reconfigured with a fixed release number
1. When a new major or minor stable release of the software is made, the `stable` branch gets duplicated into a new branch tracking that version, which then gets reconfigured with a fixed release number, and the now-stable features in the `latest` branch get cherry-picked to the `stable` branch
- This is handled by the documentation maintainers

# Making a Contribution
Expand Down Expand Up @@ -65,7 +65,7 @@ Specific processes are covered below, but the general process is:
### Improving/Adding Documentation for Released Features
> 💡 Relevant features can typically be found by looking through the public documentation for features with minimal information, and/or [searching this repository](https://github.com/bluerobotics/Cockpit-docs/issues?q=is%3Aissue+is%3Aopen+label%3Acontent) for issues with the `content` label, or [searching the software repository](https://github.com/bluerobotics/Cockpit/issues?q=is%3Apull+is%3Aclosed+label%3Adocs-minimal) for pull requests with the `docs-minimal` label.

Documentation for existing features should generally first be [added to the `latest` branch](#documenting-a-newupcoming-feature), before optionally being backported to the `beta` and/or any relevant version branches, usually via [`git cherry-pick`](https://git-scm.com/docs/git-cherry-pick).
Documentation for existing features should generally first be [added to the `latest` branch](#documenting-a-newupcoming-feature), before optionally being backported to the `stable` and/or any relevant version branches, usually via [`git cherry-pick`](https://git-scm.com/docs/git-cherry-pick).

If your changes were requested in an Issue, make sure to include "Resolves #{ISSUE-NUMBER}" in the description of your pull request, to link to and automatically close the Issue when the pull request is merged.

Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,23 @@

This repository documents the Blue Robotics' [Cockpit](https://blueos.cloud/cockpit/docs/usage/overview) software.

The documentation is generated using the [Zola](https://www.getzola.org/) static site generator.
The documentation is generated using the [Zola](https://www.getzola.org/) static site generator, together with [BlueTheme](https://github.com/bluerobotics/bluetheme).

## Structure

- Each branch covers a minor release (`X.y`) of the software, including any patches (`X.Y.z`) of that release
- The `latest` branch covers the development state in the BlueOS `master` branch, but is not expected to be consistently up to date
- The `beta` branch covers the latest beta release, and is intended to at least minimally describe all included features
- The `latest` branch covers the development state in the Cockpit `master` branch, but is not expected to be consistently up to date
- It is intended to at least minimally describe all included features in the latest available beta release
- The `stable` branch covers the latest stable version, and is intended to sufficiently describe all included features
- For ease of contribution, and to keep the search index independent between versions, each branch is built independently
- Documentation content is in the `content` directory
- The theme is provided as a submodule in the `themes` directory

## Contributing

New features should first be documented in `latest`, and subsequently branched into `beta` and a stable version toegther with the software release cycle.
New features should first be documented in `latest`, then cherry-picked into `stable` as part of the software release cycle.

Improved documentation for existing features should at least be added to `latest`, and ideally also cherry-picked into the existing `beta` and stable-versioned branches as relevant.
Improved documentation for existing features should at least be added to `latest`, and ideally also cherry-picked into the existing `stable` and numbered stable version branches as relevant.

Detailed contribution information can be found in [CONTRIBUTING.md](CONTRIBUTING.md)

Expand Down
Binary file added content/usage/advanced/about.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/usage/advanced/alert-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/usage/advanced/alert-history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/alert-mini-widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/altitude-mini-widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/arm-disarm-mini-widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/usage/advanced/attitude-hud-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/boolean-input-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/usage/advanced/burger-menu.png
Binary file not shown.
Binary file added content/usage/advanced/button-input-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/button-input.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/checkbox-input.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/clock-mini-widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/usage/advanced/compass-hud-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/custom-actions-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/custom-http-action.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/custom-mavlink-action.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/custom-widget-base.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/usage/advanced/depth-hud-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/depth-mini-widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/dev-mode-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/dial-input-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/usage/advanced/dial-input.png
Binary file added content/usage/advanced/dropdown-input-config.png
Binary file added content/usage/advanced/dropdown-input.png
Binary file modified content/usage/advanced/edit-mode.png
Binary file added content/usage/advanced/exit-fullscreen.png
Binary file added content/usage/advanced/general-config.png
Binary file added content/usage/advanced/goto.png
Binary file added content/usage/advanced/gps-mini-widget.png
Binary file modified content/usage/advanced/iframe-config.png
Binary file modified content/usage/advanced/image-viewer-config.png
Loading
Loading